Skip to content

Commit 2889f07

Browse files
Doc updates for InteropServices. (dotnet#4734)
1 parent 752438e commit 2889f07

10 files changed

+24
-16
lines changed

xml/System.Runtime.InteropServices/Architecture.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@
134134
</ReturnValue>
135135
<MemberValue>4</MemberValue>
136136
<Docs>
137-
<summary>To be added.</summary>
137+
<summary>The WebAssembly platform.</summary>
138138
</Docs>
139139
</Member>
140140
<Member MemberName="X64">

xml/System.Runtime.InteropServices/CollectionsMarshal.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@
4040
<Parameter Name="list" Type="System.Collections.Generic.List&lt;T&gt;" />
4141
</Parameters>
4242
<Docs>
43-
<typeparam name="T">To be added.</typeparam>
44-
<param name="list">To be added.</param>
43+
<typeparam name="T">The type of items in the list.</typeparam>
44+
<param name="list">List from which to create the <see cref="T:System.Span`1" /></param>
4545
<summary>Gets a <see cref="T:System.Span`1" /> view over the data in a list.
4646
Items should not be added or removed from the <see cref="T:System.Collections.Generic.List`1" /> while the <see cref="T:System.Span`1" /> is in use.</summary>
47-
<returns>To be added.</returns>
48-
<remarks>To be added.</remarks>
47+
<returns>A <see cref="T:System.Span`1" /> instance over the <see cref="T:System.Collections.Generic.List`1" /></returns>
48+
<remarks>To be added.</remarks>
4949
</Docs>
5050
</Member>
5151
</Members>

xml/System.Runtime.InteropServices/ComWrappers+ComInterfaceDispatch.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
<ReturnType>System.IntPtr</ReturnType>
6767
</ReturnValue>
6868
<Docs>
69-
<summary>To be added.</summary>
69+
<summary>Field that represents the virtual function table (vtable) in the IUnknown instance layout.</summary>
7070
<remarks>To be added.</remarks>
7171
</Docs>
7272
</Member>

xml/System.Runtime.InteropServices/ComWrappers.xml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ComWrappers" FullName="System.Runtime.InteropServices.ComWrappers">
1+
<Type Name="ComWrappers" FullName="System.Runtime.InteropServices.ComWrappers">
22
<TypeSignature Language="C#" Value="public abstract class ComWrappers" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ComWrappers extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Runtime.InteropServices.ComWrappers" />
@@ -37,7 +37,7 @@
3737
</AssemblyInfo>
3838
<Parameters />
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Instance constructor.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
</Member>
@@ -239,8 +239,16 @@ If a managed object was previously created for the specified `externalComObject`
239239
<param name="wrapper">The object to use as the wrapper for the external object.</param>
240240
<summary>Gets the currently registered managed object or uses the supplied managed object and registers it.</summary>
241241
<returns>A managed object associated with the supplied external COM object.</returns>
242-
<remarks>To be added.</remarks>
243242
<exception cref="T:System.NotSupportedException">The wrapper instance is already associated with an external object.</exception>
243+
<remarks>
244+
<format type="text/markdown"><![CDATA[
245+
246+
## Remarks
247+
248+
If the `wrapper` instance already has an associated external object a <xref:System.NotSupportedException> will be thrown.
249+
250+
]]></format>
251+
</remarks>
244252
</Docs>
245253
</Member>
246254
<Member MemberName="RegisterForMarshalling">

xml/System.Runtime.InteropServices/CreateComInterfaceFlags.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ This flag is useful in scenarios when the caller has no need to rely on an IUnkn
6969
</ReturnValue>
7070
<MemberValue>0</MemberValue>
7171
<Docs>
72-
<summary>To be added.</summary>
72+
<summary>Flag used to indicate no flags set.</summary>
7373
</Docs>
7474
</Member>
7575
<Member MemberName="TrackerSupport">

xml/System.Runtime.InteropServices/CreateObjectFlags.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
</ReturnValue>
4141
<MemberValue>0</MemberValue>
4242
<Docs>
43-
<summary>To be added.</summary>
43+
<summary>Flag used to indicate no flags set.</summary>
4444
</Docs>
4545
</Member>
4646
<Member MemberName="TrackerObject">

xml/System.Runtime.InteropServices/DynamicInterfaceCastableImplementationAttribute.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This attribute is used to enforce policy in the runtime and make <xref:System.Ru
4545
</AssemblyInfo>
4646
<Parameters />
4747
<Docs>
48-
<summary>To be added.</summary>
48+
<summary>Instance constructor.</summary>
4949
<remarks>To be added.</remarks>
5050
</Docs>
5151
</Member>

xml/System.Runtime.InteropServices/MemoryMarshal.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ This method can be useful if part of a managed object represents a fixed array.
603603
<typeparam name="T">The type of the array elements.</typeparam>
604604
<param name="array">The array to analyze.</param>
605605
<summary>Returns a reference to the 0th element of <paramref name="array" />. If the array is empty, returns a reference to where the 0th element would have been stored. Such a reference may be used for pinning but must never be dereferenced.</summary>
606-
<returns>To be added.</returns>
606+
<returns>Reference to the 0th element in <paramref name="array" /></returns>
607607
<remarks>
608608
<format type="text/markdown"><![CDATA[
609609

xml/System.Runtime.InteropServices/OSPlatform.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@
6464
<ReturnType>System.Runtime.InteropServices.OSPlatform</ReturnType>
6565
</ReturnValue>
6666
<Docs>
67-
<summary>To be added.</summary>
68-
<value>To be added.</value>
67+
<summary>Gets an object that represents the Browser as an operating system.</summary>
68+
<value>An object that represents the Browser as an operating system.</value>
6969
<remarks>To be added.</remarks>
7070
</Docs>
7171
</Member>

xml/System.Runtime.InteropServices/SuppressGCTransitionAttribute.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ This attribute is ignored if applied to a method without the <xref:System.Runtim
6565
</AssemblyInfo>
6666
<Parameters />
6767
<Docs>
68-
<summary>To be added.</summary>
68+
<summary>Instance constructor.</summary>
6969
<remarks>To be added.</remarks>
7070
</Docs>
7171
</Member>

0 commit comments

Comments
 (0)