Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port over more doc comments #9169

Merged
merged 3 commits into from
Jul 28, 2023
Merged

Conversation

jkoritzinsky
Copy link
Member

A lot of these had issues porting over, so some of them were manually ported. I added the default constructor docs here directly so we didn't have to add default constructors into the C# source.

This is primarily System.Runtime.InteropServices docs, with some other docs automatically ported over as part of the process.

Summary

Contributes to dotnet/runtime#88573, dotnet/runtime#88565, dotnet/runtime#88569

This should cover the remaining APIs in dotnet/runtime#88573 (I went through the table manually to make sure I got them), but I don't want to close the issue until I have confirmation from @carlossanlop that I got all of them.

A lot of these had issues porting over, so some of them were manually ported. I added the default constructor docs here directly so we didn't have to add default constructors into the C# source.

This is primarily System.Runtime.InteropServices docs, with some other docs automatically ported over as part of the process.
@learn-build-service-prod
Copy link

Learn Build status updates of commit 24a8bf6:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Runtime.InteropServices.Marshalling/ComObject.xml 💡Suggestion View Details
xml/System.Collections.Immutable/ImmutableArray`1.xml ✅Succeeded View
xml/System.Collections.Immutable/ImmutableArray`1+Builder.xml ✅Succeeded View
xml/System.Net/IPAddress.xml ✅Succeeded View
xml/System.Net/IPNetwork.xml ✅Succeeded View
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/ComInterfaceOptions.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/IIUnknownCacheStrategy+TableInfo.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/StrategyBasedComWrappers.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/UniqueComInterfaceMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices/CollectionsMarshal.xml ✅Succeeded View
xml/System.Runtime.InteropServices/ImmutableCollectionsMarshal.xml ✅Succeeded View
xml/System.Runtime.InteropServices/NFloat.xml ✅Succeeded View

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).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:System#Runtime#InteropServices#IDynamicInterfaceCastable#IsInterfaceImplemented(System.RuntimeTypeHandle,System.Boolean) for uid: System.Runtime.InteropServices.Marshalling.ComObject.System#Runtime#InteropServices#IDynamicInterfaceCastable#IsInterfaceImplemented(System.RuntimeTypeHandle,System.Boolean).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:System#Runtime#InteropServices#Marshalling#IUnmanagedVirtualMethodTableProvider#GetVirtualMethodTableInfoForKey(System.Type) for uid: System.Runtime.InteropServices.Marshalling.ComObject.System#Runtime#InteropServices#Marshalling#IUnmanagedVirtualMethodTableProvider#GetVirtualMethodTableInfoForKey(System.Type).

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:

@learn-build-service-prod
Copy link

Learn Build status updates of commit 11a8137:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Runtime.InteropServices.Marshalling/ComObject.xml 💡Suggestion View Details
xml/System.Collections.Immutable/ImmutableArray`1.xml ✅Succeeded View
xml/System.Collections.Immutable/ImmutableArray`1+Builder.xml ✅Succeeded View
xml/System.Net/IPAddress.xml ✅Succeeded View
xml/System.Net/IPNetwork.xml ✅Succeeded View
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/ComInterfaceOptions.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/IIUnknownCacheStrategy+TableInfo.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/StrategyBasedComWrappers.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/UniqueComInterfaceMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices/CollectionsMarshal.xml ✅Succeeded View
xml/System.Runtime.InteropServices/ImmutableCollectionsMarshal.xml ✅Succeeded View
xml/System.Runtime.InteropServices/NFloat.xml ✅Succeeded View

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).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:System#Runtime#InteropServices#IDynamicInterfaceCastable#IsInterfaceImplemented(System.RuntimeTypeHandle,System.Boolean) for uid: System.Runtime.InteropServices.Marshalling.ComObject.System#Runtime#InteropServices#IDynamicInterfaceCastable#IsInterfaceImplemented(System.RuntimeTypeHandle,System.Boolean).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:System#Runtime#InteropServices#Marshalling#IUnmanagedVirtualMethodTableProvider#GetVirtualMethodTableInfoForKey(System.Type) for uid: System.Runtime.InteropServices.Marshalling.ComObject.System#Runtime#InteropServices#Marshalling#IUnmanagedVirtualMethodTableProvider#GetVirtualMethodTableInfoForKey(System.Type).

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:

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@jkoritzinsky jkoritzinsky enabled auto-merge (squash) July 28, 2023 22:19
@learn-build-service-prod
Copy link

Learn Build status updates of commit 925f01d:

💡 Validation status: suggestions

File Status Preview URL Details
xml/System.Runtime.InteropServices.Marshalling/ComObject.xml 💡Suggestion View Details
xml/System.Collections.Immutable/ImmutableArray`1.xml ✅Succeeded View
xml/System.Collections.Immutable/ImmutableArray`1+Builder.xml ✅Succeeded View
xml/System.Net/IPAddress.xml ✅Succeeded View
xml/System.Net/IPNetwork.xml ✅Succeeded View
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/ComInterfaceOptions.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/IIUnknownCacheStrategy+TableInfo.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/StrategyBasedComWrappers.xml ✅Succeeded View
xml/System.Runtime.InteropServices.Marshalling/UniqueComInterfaceMarshaller`1.xml ✅Succeeded View
xml/System.Runtime.InteropServices/CollectionsMarshal.xml ✅Succeeded View
xml/System.Runtime.InteropServices/ImmutableCollectionsMarshal.xml ✅Succeeded View
xml/System.Runtime.InteropServices/NFloat.xml ✅Succeeded View

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).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:System#Runtime#InteropServices#IDynamicInterfaceCastable#IsInterfaceImplemented(System.RuntimeTypeHandle,System.Boolean) for uid: System.Runtime.InteropServices.Marshalling.ComObject.System#Runtime#InteropServices#IDynamicInterfaceCastable#IsInterfaceImplemented(System.RuntimeTypeHandle,System.Boolean).
  • Line 0, Column 0: [Suggestion: ECMA2Yaml_Inheritdoc_NoFoundParent] Found no member can be inherited by key:System#Runtime#InteropServices#Marshalling#IUnmanagedVirtualMethodTableProvider#GetVirtualMethodTableInfoForKey(System.Type) for uid: System.Runtime.InteropServices.Marshalling.ComObject.System#Runtime#InteropServices#Marshalling#IUnmanagedVirtualMethodTableProvider#GetVirtualMethodTableInfoForKey(System.Type).

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 merged commit 6a00c0b into dotnet:main Jul 28, 2023
3 checks passed
@jkoritzinsky jkoritzinsky deleted the additional-docs branch July 28, 2023 22:50
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.

None yet

2 participants