Skip to content

Port over docs for System.Runtime.InteropServices#9132

Merged
jkoritzinsky merged 5 commits into
dotnet:mainfrom
jkoritzinsky:interopservices-docs-update
Jul 11, 2023
Merged

Port over docs for System.Runtime.InteropServices#9132
jkoritzinsky merged 5 commits into
dotnet:mainfrom
jkoritzinsky:interopservices-docs-update

Conversation

@jkoritzinsky

Copy link
Copy Markdown
Member

Summary

Port documentation from dotnet/runtime for System.Runtime.InteropServices.dll.

Depends on dotnet/runtime#88627

Contributes to dotnet/runtime#88561 (it might fix it, not sure what other docs are still missing after this PR).

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@AaronRobinsonMSFT

Copy link
Copy Markdown
Member

Do we address all the missing comments described at dotnet/runtime#88573.

@jkoritzinsky

Copy link
Copy Markdown
Member Author

Do we address all the missing comments described at dotnet/runtime#88573.

I believe so, but I still am working through the validation. @carlossanlop what tool do you use to determine which APIs are missing documentation? I'd like to use it to validate that this PR covers all of the APIs in our area.

@gewarren gewarren left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm about 3/4 of the way through so far (to IIUnknownStrategy.xml).

Comment thread xml/System.Runtime.InteropServices.Marshalling/ComExposedClassAttribute`1.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/ComInterfaceMarshaller`1.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/ComInterfaceMarshaller`1.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/ComInterfaceMarshaller`1.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/ComInterfaceMarshaller`1.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/IIUnknownInterfaceType.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/IIUnknownInterfaceType.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/IIUnknownInterfaceType.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/IIUnknownStrategy.xml Outdated
@learn-build-service-prod

This comment was marked as outdated.

gewarren

This comment was marked as duplicate.

@gewarren gewarren left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's the rest of my suggestions.

Comment thread xml/System.Runtime.InteropServices.Marshalling/IIUnknownStrategy.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/IIUnknownStrategy.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/IIUnknownStrategy.xml Outdated
Comment thread xml/System.Runtime.InteropServices.Marshalling/IUnknownDerivedAttribute`2.xml Outdated
Comment thread xml/System.Runtime.InteropServices/NFloat.xml Outdated
Comment thread xml/System.Runtime.InteropServices/NFloat.xml Outdated
Comment thread xml/System.Runtime.InteropServices/NFloat.xml Outdated
Comment thread xml/System.Runtime.InteropServices/NFloat.xml Outdated
Comment thread xml/System.Runtime.InteropServices/NFloat.xml Outdated
jkoritzinsky and others added 2 commits July 11, 2023 15:38
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@learn-build-service-prod

Copy link
Copy Markdown

Learn Build status updates of commit c268e78:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Runtime.InteropServices.Marshalling/ComObject.xml 💡Suggestion View Details
xml/System.Runtime.InteropServices.Marshalling/ComExposedClassAttribute`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ComInterfaceMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ExceptionAsDefaultMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ExceptionAsHResultMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ExceptionAsNaNMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ExceptionAsVoidMarshaller.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/GeneratedComClassAttribute.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/GeneratedComInterfaceAttribute.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IComExposedClass.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IComExposedDetails.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownCacheStrategy.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownDerivedDetails.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownInterfaceDetailsStrategy.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownInterfaceType.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownStrategy.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IUnknownDerivedAttribute`2.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IUnmanagedVirtualMethodTableProvider.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/SafeHandleMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/SafeHandleMarshaller`1+ManagedToUnmanagedIn.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/SafeHandleMarshaller`1+ManagedToUnmanagedOut.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/SafeHandleMarshaller`1+ManagedToUnmanagedRef.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/UniqueComInterfaceMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/VirtualMethodTableInfo.xml ✅Succeeded View
xml/System.Runtime.InteropServices/CollectionsMarshal.xml ✅Succeeded View

This comment lists only the first 25 files in the pull request.

xml/System.Runtime.InteropServices.Marshalling/ComObject.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:System#Runtime#InteropServices#IDynamicInterfaceCastable#GetInterfaceImplementation(System.RuntimeTypeHandle) for uid: System.Runtime.InteropServices.Marshalling.ComObject.System#Runtime#InteropServices#IDynamicInterfaceCastable#GetInterfaceImplementation(System.RuntimeTypeHandle).

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@jkoritzinsky jkoritzinsky requested a review from gewarren July 11, 2023 23:15

@gewarren gewarren left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jkoritzinsky jkoritzinsky enabled auto-merge (squash) July 11, 2023 23:30
@learn-build-service-prod

Copy link
Copy Markdown

Learn Build status updates of commit a6d7d34:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Runtime.InteropServices.Marshalling/ComObject.xml 💡Suggestion View Details
xml/System.Runtime.InteropServices.Marshalling/ComExposedClassAttribute`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ComInterfaceMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ExceptionAsDefaultMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ExceptionAsHResultMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ExceptionAsNaNMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/ExceptionAsVoidMarshaller.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/GeneratedComClassAttribute.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/GeneratedComInterfaceAttribute.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IComExposedClass.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IComExposedDetails.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownCacheStrategy.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownDerivedDetails.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownInterfaceDetailsStrategy.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownInterfaceType.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IIUnknownStrategy.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IUnknownDerivedAttribute`2.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/IUnmanagedVirtualMethodTableProvider.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/SafeHandleMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/SafeHandleMarshaller`1+ManagedToUnmanagedIn.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/SafeHandleMarshaller`1+ManagedToUnmanagedOut.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/SafeHandleMarshaller`1+ManagedToUnmanagedRef.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/UniqueComInterfaceMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/VirtualMethodTableInfo.xml ✅Succeeded View
xml/System.Runtime.InteropServices/CollectionsMarshal.xml ✅Succeeded View

This comment lists only the first 25 files in the pull request.

xml/System.Runtime.InteropServices.Marshalling/ComObject.xml

  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:System#Runtime#InteropServices#IDynamicInterfaceCastable#GetInterfaceImplementation(System.RuntimeTypeHandle) for uid: System.Runtime.InteropServices.Marshalling.ComObject.System#Runtime#InteropServices#IDynamicInterfaceCastable#GetInterfaceImplementation(System.RuntimeTypeHandle).

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants