Skip to content

Commit 3e0e8b4

Browse files
AnipikRon Petrusha
andcommitted
Adding Api-docs for System.Runtime.IntropServices (#2780)
* Add docs for apis in System.Runtime.IntropServices * Addressing feedback Co-Authored-By: Ron Petrusha <[email protected]>
1 parent d024b04 commit 3e0e8b4

File tree

4 files changed

+30
-22
lines changed

4 files changed

+30
-22
lines changed

xml/System.Reflection/EventInfo.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,7 @@ add_<EventName>(<EventHandlerType> handler)
646646
<Parameters />
647647
<Docs>
648648
<summary>Returns the public methods that have been associated with an event in metadata using the <see langword=".other" /> directive.</summary>
649-
<returns>An array of <see cref="T:System.Reflection.EventInfo" /> objects representing the public methods that have been associated with the event in metadata by using the <see langword=".other" /> directive. If there are no such public methods, an empty array is returned.</returns>
649+
<returns>An array representing the public methods that have been associated with the event in metadata by using the <see langword=".other" /> directive. If there are no such public methods, an empty array is returned.</returns>
650650
<remarks>
651651
<format type="text/markdown"><![CDATA[
652652
@@ -704,7 +704,7 @@ add_<EventName>(<EventHandlerType> handler)
704704
<param name="nonPublic">
705705
<see langword="true" /> to include non-public methods; otherwise, <see langword="false" />.</param>
706706
<summary>Returns the methods that have been associated with the event in metadata using the <see langword=".other" /> directive, specifying whether to include non-public methods.</summary>
707-
<returns>An array of <see cref="T:System.Reflection.EventInfo" /> objects representing methods that have been associated with an event in metadata by using the <see langword=".other" /> directive. If there are no methods matching the specification, an empty array is returned.</returns>
707+
<returns>An array representing methods that have been associated with an event in metadata by using the <see langword=".other" /> directive. If there are no methods matching the specification, an empty array is returned.</returns>
708708
<remarks>
709709
<format type="text/markdown"><![CDATA[
710710
@@ -1654,4 +1654,4 @@ remove_<EventName>(<EventHandlerType> handler)
16541654
</Docs>
16551655
</Member>
16561656
</Members>
1657-
</Type>
1657+
</Type>

xml/System.Runtime.InteropServices/ComAwareEventInfo.xml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -413,8 +413,8 @@
413413
</ReturnValue>
414414
<Parameters />
415415
<Docs>
416-
<summary>To be added.</summary>
417-
<returns>To be added.</returns>
416+
<summary>Returns a list of <see cref="T:System.Reflection.CustomAttributeData" /> objects for the current <see cref="T:System.Runtime.InteropServices.ComAwareEventInfo"/>.</summary>
417+
<returns>A generic list of <see cref="T:System.Reflection.CustomAttributeData" /> objects representing data about the attributes that have been applied to the current <see cref="T:System.Runtime.InteropServices.ComAwareEventInfo"/>.</returns>
418418
<remarks>To be added.</remarks>
419419
</Docs>
420420
</Member>
@@ -443,9 +443,10 @@
443443
<Parameter Name="nonPublic" Type="System.Boolean" Index="0" FrameworkAlternate="netcore-3.0" />
444444
</Parameters>
445445
<Docs>
446-
<param name="nonPublic">To be added.</param>
447-
<summary>To be added.</summary>
448-
<returns>To be added.</returns>
446+
<param name="nonPublic">
447+
<see langword="true" /> to include non-public methods; otherwise, <see langword="false" />.</param>
448+
<summary>Returns the public or non-public methods that have been associated with an event in metadata.</summary>
449+
<returns>An array representing the methods that have been associated with the event in metadata. If there are no such methods, an empty array is returned.</returns>
449450
<remarks>To be added.</remarks>
450451
</Docs>
451452
</Member>
@@ -603,8 +604,8 @@
603604
<ReturnType>System.Int32</ReturnType>
604605
</ReturnValue>
605606
<Docs>
606-
<summary>To be added.</summary>
607-
<value>To be added.</value>
607+
<summary>Gets the metadata token associated with the current <see cref="T:System.Runtime.InteropServices.ComAwareEventInfo" /> object.</summary>
608+
<value>A 32-bit Integer that represents the metadata token.</value>
608609
<remarks>To be added.</remarks>
609610
</Docs>
610611
</Member>
@@ -630,8 +631,8 @@
630631
<ReturnType>System.Reflection.Module</ReturnType>
631632
</ReturnValue>
632633
<Docs>
633-
<summary>To be added.</summary>
634-
<value>To be added.</value>
634+
<summary>Gets the module associated with the current <see cref="T:System.Runtime.InteropServices.ComAwareEventInfo" /> object.</summary>
635+
<value>The module associated with the current <see cref="T:System.Runtime.InteropServices.ComAwareEventInfo" /> object.</value>
635636
<remarks>To be added.</remarks>
636637
</Docs>
637638
</Member>
@@ -794,4 +795,4 @@
794795
</Docs>
795796
</Member>
796797
</Members>
797-
</Type>
798+
</Type>

xml/System.Runtime.InteropServices/DllImportResolver.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
<ReturnType>System.IntPtr</ReturnType>
2222
</ReturnValue>
2323
<Docs>
24-
<param name="libraryName">To be added.</param>
25-
<param name="assembly">To be added.</param>
26-
<param name="searchPath">To be added.</param>
24+
<param name="libraryName">The native library to resolve.</param>
25+
<param name="assembly">The assembly requesting the resolution.</param>
26+
<param name="searchPath">The <see cref="T:System.Runtime.InteropServices.DefaultDllImportSearchPathsAttribute" /> on the PInvoke, if any. Otherwise, the <see cref="T:System.Runtime.InteropServices.DefaultDllImportSearchPathsAttribute" /> on the assembly, if any. Otherwise <see langword="null" />.</param>
2727
<summary>Provides a delegate used to resolve native libraries via callback.</summary>
28-
<returns>To be added.</returns>
28+
<returns>The handle for the loaded native library on success, or <see cref="F:System.IntPtr.Zero" /> on failure.</returns>
2929
<remarks>To be added.</remarks>
3030
</Docs>
3131
</Type>

xml/System.Runtime.InteropServices/UCOMITypeLib.xml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -340,10 +340,17 @@
340340
<Parameter Name="pTKind" Type="System.Runtime.InteropServices.ComTypes.TYPEKIND" RefType="out" Index="1" FrameworkAlternate="netcore-3.0" />
341341
</Parameters>
342342
<Docs>
343-
<param name="index">To be added.</param>
344-
<param name="pTKind">To be added.</param>
345-
<summary>To be added.</summary>
346-
<remarks>To be added.</remarks>
343+
<param name="index">The index of the type description within the type library</param>
344+
<param name="pTKind">A reference to the <see langword="TYPEKIND" /> enumeration for the type description.</param>
345+
<summary>Retrieves the type of a type description.</summary>
346+
<remarks>
347+
<format type="text/markdown"><![CDATA[
348+
349+
## Remarks
350+
For additional information, see [ITypeLib::GetTypeInfoType](/windows/win32/api/oaidl/nf-oaidl-itypelib-gettypeinfotype).
351+
352+
]]></format>
353+
</remarks>
347354
</Docs>
348355
</Member>
349356
<Member MemberName="GetTypeInfoType">
@@ -463,4 +470,4 @@
463470
</Docs>
464471
</Member>
465472
</Members>
466-
</Type>
473+
</Type>

0 commit comments

Comments
 (0)