Skip to content

Commit cef06e1

Browse files
jkoritzinskygewarren
jkoritzinsky
and
gewarren
authored
Port over docs for System.Runtime.InteropServices (dotnet#9132)
Co-authored-by: Genevieve Warren <[email protected]>
1 parent 01d37cc commit cef06e1

27 files changed

+274
-244
lines changed

‎xml/System.Runtime.InteropServices.Marshalling/ComExposedClassAttribute`1.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
</Attribute>
3636
</Attributes>
3737
<Docs>
38-
<typeparam name="T">To be added.</typeparam>
39-
<summary>To be added.</summary>
38+
<typeparam name="T">The type that provides information about how to expose the attributed type to COM.</typeparam>
39+
<summary>Indicates that a type's instances should be exposed to COM.</summary>
4040
<remarks>To be added.</remarks>
4141
</Docs>
4242
<Members>
@@ -82,6 +82,7 @@
8282
<summary>To be added.</summary>
8383
<returns>To be added.</returns>
8484
<remarks>To be added.</remarks>
85+
<inheritdoc />
8586
</Docs>
8687
</Member>
8788
</Members>

‎xml/System.Runtime.InteropServices.Marshalling/ComInterfaceMarshaller`1.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@
4444
</Attributes>
4545
<Docs>
4646
<typeparam name="T">To be added.</typeparam>
47-
<summary>To be added.</summary>
48-
<remarks>To be added.</remarks>
47+
<summary>Marshals a COM interface using a <see cref="T:System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers" /> instance.</summary>
48+
<remarks>This marshaller always passes the <see cref="F:System.Runtime.InteropServices.CreateObjectFlags.Unwrap" /> flag to <see cref="M:System.Runtime.InteropServices.ComWrappers.GetOrCreateObjectForComInstance(System.IntPtr,System.Runtime.InteropServices.CreateObjectFlags)" />.</remarks>
4949
</Docs>
5050
<Members>
5151
<Member MemberName="ConvertToManaged">
@@ -66,10 +66,10 @@
6666
<Parameter Name="unmanaged" Type="System.Void*" />
6767
</Parameters>
6868
<Docs>
69-
<param name="unmanaged">To be added.</param>
70-
<summary>To be added.</summary>
71-
<returns>To be added.</returns>
72-
<remarks>To be added.</remarks>
69+
<param name="unmanaged">The COM interface pointer.</param>
70+
<summary>Converts a COM interface pointer to a managed object.</summary>
71+
<returns>A managed object that represents the passed in COM interface pointer, or the managed object represented by the passed in pointer.</returns>
72+
<remarks>If the passed in COM interface pointer wraps a managed object, this method returns the underlying object.</remarks>
7373
</Docs>
7474
</Member>
7575
<Member MemberName="ConvertToUnmanaged">
@@ -90,9 +90,9 @@
9090
<Parameter Name="managed" Type="T" />
9191
</Parameters>
9292
<Docs>
93-
<param name="managed">To be added.</param>
94-
<summary>To be added.</summary>
95-
<returns>To be added.</returns>
93+
<param name="managed">The managed object.</param>
94+
<summary>Converts a managed object to a COM interface pointer for the COM interface represented by <typeparamref name="T" />.</summary>
95+
<returns>The COM interface pointer.</returns>
9696
<remarks>To be added.</remarks>
9797
</Docs>
9898
</Member>

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

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</Interface>
2222
</Interfaces>
2323
<Docs>
24-
<summary>To be added.</summary>
24+
<summary>Base class for all COM source-generated runtime callable wrappers (RCWs).</summary>
2525
<remarks>To be added.</remarks>
2626
</Docs>
2727
<Members>
@@ -42,7 +42,7 @@
4242
</ReturnValue>
4343
<Parameters />
4444
<Docs>
45-
<summary>To be added.</summary>
45+
<summary>Releases all references to the underlying COM object.</summary>
4646
<remarks>To be added.</remarks>
4747
</Docs>
4848
</Member>
@@ -63,8 +63,8 @@
6363
</ReturnValue>
6464
<Parameters />
6565
<Docs>
66-
<summary>To be added.</summary>
67-
<remarks>To be added.</remarks>
66+
<summary>Releases all references owned by this <see cref="T:System.Runtime.InteropServices.Marshalling.ComObject" /> if it is a unique instance.</summary>
67+
<remarks>This method does nothing if the <see cref="T:System.Runtime.InteropServices.Marshalling.ComObject" /> was not created with <see cref="F:System.Runtime.InteropServices.CreateObjectFlags.UniqueInstance" />.</remarks>
6868
</Docs>
6969
</Member>
7070
<Member MemberName="System.Runtime.InteropServices.IDynamicInterfaceCastable.GetInterfaceImplementation">
@@ -89,10 +89,11 @@
8989
<Parameter Name="interfaceType" Type="System.RuntimeTypeHandle" />
9090
</Parameters>
9191
<Docs>
92-
<param name="interfaceType">To be added.</param>
93-
<summary>To be added.</summary>
94-
<returns>To be added.</returns>
92+
<param name="interfaceType">The interface type.</param>
93+
<summary>Determines the type to use to dispatch the specified interface type. This method is called during interface dispatch when the given interface type can't be found in the class's metadata.</summary>
94+
<returns>The type that should be used to dispatch for <paramref name="interfaceType" /> on the current object.</returns>
9595
<remarks>To be added.</remarks>
96+
<inheritdoc />
9697
</Docs>
9798
</Member>
9899
<Member MemberName="System.Runtime.InteropServices.IDynamicInterfaceCastable.IsInterfaceImplemented">
@@ -118,10 +119,11 @@
118119
<Parameter Name="throwIfNotImplemented" Type="System.Boolean" />
119120
</Parameters>
120121
<Docs>
121-
<param name="interfaceType">To be added.</param>
122-
<param name="throwIfNotImplemented">To be added.</param>
123-
<summary>To be added.</summary>
124-
<returns>To be added.</returns>
122+
<param name="interfaceType">The interface type.</param>
123+
<param name="throwIfNotImplemented"><see langword="true" /> to throw an exception instead of returning <see langword="false" />; otherwise, <see langword="false" />.</param>
124+
<summary>Determines if this object can be cast to the specified interface type. This method is called when an implementing class instance is cast to an interface type that's not contained in the class's metadata.</summary>
125+
<returns>
126+
<see langword="true" /> if this object can be cast to the given interface; otherwise, <see langword="false" />.</returns>
125127
<remarks>To be added.</remarks>
126128
</Docs>
127129
</Member>
@@ -147,9 +149,9 @@
147149
<Parameter Name="type" Type="System.Type" />
148150
</Parameters>
149151
<Docs>
150-
<param name="type">To be added.</param>
151-
<summary>To be added.</summary>
152-
<returns>To be added.</returns>
152+
<param name="type">The managed type for the unmanaged interface.</param>
153+
<summary>Get the information about the virtual method table for a given unmanaged interface type represented by <paramref name="type"/>.</summary>
154+
<returns>The virtual method table information for the unmanaged interface.</returns>
153155
<remarks>To be added.</remarks>
154156
</Docs>
155157
</Member>

‎xml/System.Runtime.InteropServices.Marshalling/ExceptionAsDefaultMarshaller`1.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
</Attribute>
3030
</Attributes>
3131
<Docs>
32-
<typeparam name="T">To be added.</typeparam>
33-
<summary>To be added.</summary>
32+
<typeparam name="T">The unmanaged type.</typeparam>
33+
<summary>Converts the exception to the default value of the specified unmanaged type.</summary>
3434
<remarks>To be added.</remarks>
3535
</Docs>
3636
<Members>
@@ -53,9 +53,9 @@
5353
<Parameter Name="e" Type="System.Exception" />
5454
</Parameters>
5555
<Docs>
56-
<param name="e">To be added.</param>
57-
<summary>To be added.</summary>
58-
<returns>To be added.</returns>
56+
<param name="e">The exception</param>
57+
<summary>Converts the specified exception to the default value of the unmanaged type.</summary>
58+
<returns>The default value of <typeparamref name="T" />.</returns>
5959
<remarks>To be added.</remarks>
6060
</Docs>
6161
</Member>

‎xml/System.Runtime.InteropServices.Marshalling/ExceptionAsHResultMarshaller`1.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@
2929
</Attribute>
3030
</Attributes>
3131
<Docs>
32-
<typeparam name="T">To be added.</typeparam>
33-
<summary>To be added.</summary>
34-
<remarks>To be added.</remarks>
32+
<typeparam name="T">The unmanaged type to convert the HResult to.</typeparam>
33+
<summary>Marshals an exception object to the value of its <see cref="P:System.Exception.HResult" /> converted to <typeparamref name="T" />.</summary>
34+
<remarks>This type is used by the COM source generator to enable marshalling exceptions to the HResult of the exception.</remarks>
3535
</Docs>
3636
<Members>
3737
<Member MemberName="ConvertToUnmanaged">
@@ -53,9 +53,9 @@
5353
<Parameter Name="e" Type="System.Exception" />
5454
</Parameters>
5555
<Docs>
56-
<param name="e">To be added.</param>
57-
<summary>To be added.</summary>
58-
<returns>To be added.</returns>
56+
<param name="e">The exception.</param>
57+
<summary>Marshals an exception object to the value of its <see cref="P:System.Exception.HResult" /> converted to <typeparamref name="T" />.</summary>
58+
<returns>The HResult of the exception, converted to <typeparamref name="T" />.</returns>
5959
<remarks>To be added.</remarks>
6060
</Docs>
6161
</Member>

‎xml/System.Runtime.InteropServices.Marshalling/ExceptionAsNaNMarshaller`1.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
</Attribute>
3030
</Attributes>
3131
<Docs>
32-
<typeparam name="T">To be added.</typeparam>
33-
<summary>To be added.</summary>
32+
<typeparam name="T">The unmanaged type to return the <c>NaN</c> value for.</typeparam>
33+
<summary>Converts all exceptions to <see cref="P:System.Numerics.IFloatingPointIeee754`1.NaN" />.</summary>
3434
<remarks>To be added.</remarks>
3535
</Docs>
3636
<Members>
@@ -53,9 +53,10 @@
5353
<Parameter Name="e" Type="System.Exception" />
5454
</Parameters>
5555
<Docs>
56-
<param name="e">To be added.</param>
57-
<summary>To be added.</summary>
58-
<returns>To be added.</returns>
56+
<param name="e">The exception.</param>
57+
<summary>Converts the specified exception to <see cref="P:System.Numerics.IFloatingPointIeee754`1.NaN" />.</summary>
58+
<returns>
59+
<see cref="P:System.Numerics.IFloatingPointIeee754`1.NaN" />.</returns>
5960
<remarks>To be added.</remarks>
6061
</Docs>
6162
</Member>

‎xml/System.Runtime.InteropServices.Marshalling/ExceptionAsVoidMarshaller.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Represents a marshaller that swallows exceptions.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -43,8 +43,8 @@
4343
<Parameter Name="e" Type="System.Exception" />
4444
</Parameters>
4545
<Docs>
46-
<param name="e">To be added.</param>
47-
<summary>To be added.</summary>
46+
<param name="e">The exception.</param>
47+
<summary>Swallows the specified exception and returns nothing.</summary>
4848
<remarks>To be added.</remarks>
4949
</Docs>
5050
</Member>

‎xml/System.Runtime.InteropServices.Marshalling/GeneratedComClassAttribute.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
24-
<remarks>To be added.</remarks>
23+
<summary>Specifies that the attributed type will be exposed to COM through source-generated COM and that the source generator should generate code for it.</summary>
24+
<remarks>This attribute is only valid on types that implement at least one <see cref="T:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute" />-attributed interface.</remarks>
2525
</Docs>
2626
<Members>
2727
<Member MemberName=".ctor">

‎xml/System.Runtime.InteropServices.Marshalling/GeneratedComInterfaceAttribute.xml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Specifies that the attributed type is a COM interface and that the source generator should generate code for it.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -57,9 +57,10 @@
5757
<ReturnType>System.Runtime.InteropServices.StringMarshalling</ReturnType>
5858
</ReturnValue>
5959
<Docs>
60-
<summary>To be added.</summary>
60+
<summary>Gets or sets a value that specifies how to marshal string arguments to all methods on the interface.
61+
If the attributed interface inherits from another interface with <see cref="T:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute" />, it must have the same values for <see cref="P:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute.StringMarshalling" /> and <see cref="P:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute.StringMarshallingCustomType" />.</summary>
6162
<value>To be added.</value>
62-
<remarks>To be added.</remarks>
63+
<remarks>If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />, <see cref="P:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute.StringMarshallingCustomType" /> must not be specified.</remarks>
6364
</Docs>
6465
</Member>
6566
<Member MemberName="StringMarshallingCustomType">
@@ -78,9 +79,10 @@
7879
<ReturnType>System.Type</ReturnType>
7980
</ReturnValue>
8081
<Docs>
81-
<summary>To be added.</summary>
82+
<summary>Gets or sets the <see cref="T:System.Type" /> used to control how string arguments are marshalled for all methods on the interface.
83+
If the attributed interface inherits from another interface with <see cref="T:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute" />, it must have the same values for <see cref="P:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute.StringMarshalling" /> and <see cref="P:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute.StringMarshallingCustomType" />.</summary>
8284
<value>To be added.</value>
83-
<remarks>To be added.</remarks>
85+
<remarks>If this field is specified, <see cref="P:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute.StringMarshalling" /> must not be specified or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.</remarks>
8486
</Docs>
8587
</Member>
8688
</Members>

‎xml/System.Runtime.InteropServices.Marshalling/IComExposedClass.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</Attribute>
1818
</Attributes>
1919
<Docs>
20-
<summary>To be added.</summary>
20+
<summary>Defines type-level information for managed class types exposed to COM.</summary>
2121
<remarks>To be added.</remarks>
2222
</Docs>
2323
<Members>
@@ -39,9 +39,9 @@
3939
<Parameter Name="count" Type="System.Int32" RefType="out" />
4040
</Parameters>
4141
<Docs>
42-
<param name="count">To be added.</param>
43-
<summary>To be added.</summary>
44-
<returns>To be added.</returns>
42+
<param name="count">The number of COM interfaces this type implements.</param>
43+
<summary>Gets the COM interface information to provide to a <see cref="T:System.Runtime.InteropServices.ComWrappers" /> instance to expose this type to COM.</summary>
44+
<returns>The interface entry information for the interfaces the type implements.</returns>
4545
<remarks>To be added.</remarks>
4646
</Docs>
4747
</Member>

0 commit comments

Comments
 (0)