Skip to content

Commit 6a00c0b

Browse files
jkoritzinskygewarren
jkoritzinsky
and
gewarren
authored
Port over more doc comments (dotnet#9169)
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
1 parent 4c356d0 commit 6a00c0b

18 files changed

+111
-88
lines changed

‎xml/System.Collections.Immutable/ImmutableArray`1+Builder.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -780,9 +780,9 @@
780780
</ReturnValue>
781781
<Parameters />
782782
<Docs>
783-
<summary>To be added.</summary>
784-
<returns>To be added.</returns>
785-
<remarks>To be added.</remarks>
783+
<summary>Returns the current contents as an <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> and sets the collection to a zero length array.</summary>
784+
<returns>An immutable array.</returns>
785+
<remarks>If <see cref="P:System.Collections.Immutable.ImmutableArray`1.Builder.Capacity" /> equals <see cref="P:System.Collections.Immutable.ImmutableArray`1.Builder.Count" />, the internal array will be extracted as an <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> without copying the contents. Otherwise, the contents will be copied into a new array. The collection will then be set to a zero length array.</remarks>
786786
</Docs>
787787
</Member>
788788
<Member MemberName="GetEnumerator">

‎xml/System.Collections.Immutable/ImmutableArray`1.xml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -754,10 +754,12 @@ This example shows how to create an immutable array using <xref:System.Collectio
754754
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-8.0" />
755755
</Parameters>
756756
<Docs>
757-
<param name="item">To be added.</param>
758-
<param name="equalityComparer">To be added.</param>
759-
<summary>To be added.</summary>
760-
<returns>To be added.</returns>
757+
<param name="item">The item to search for.</param>
758+
<param name="equalityComparer">The equality comparer to use in the search.
759+
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
760+
<summary>Determines whether the specified item exists in the array.</summary>
761+
<returns>
762+
<see langword="true" /> if an equal value was found in the array; <see langword="false" /> otherwise.</returns>
761763
<remarks>To be added.</remarks>
762764
</Docs>
763765
</Member>

‎xml/System.Net/IPAddress.xml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2434,12 +2434,13 @@
24342434
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="net-8.0" />
24352435
</Parameters>
24362436
<Docs>
2437-
<param name="utf8Destination">To be added.</param>
2438-
<param name="bytesWritten">To be added.</param>
2439-
<param name="format">To be added.</param>
2440-
<param name="provider">To be added.</param>
2441-
<summary>To be added.</summary>
2442-
<returns>To be added.</returns>
2437+
<param name="utf8Destination">The span in which to write this instance's value formatted as a span of bytes.</param>
2438+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <paramref name="utf8Destination" />.</param>
2439+
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <paramref name="utf8Destination" />.</param>
2440+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="utf8Destination" />.</param>
2441+
<summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary>
2442+
<returns>
2443+
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
24432444
<remarks>To be added.</remarks>
24442445
</Docs>
24452446
</Member>

‎xml/System.Net/IPNetwork.xml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -547,12 +547,13 @@
547547
<Parameter Name="provider" Type="System.IFormatProvider" />
548548
</Parameters>
549549
<Docs>
550-
<param name="utf8Destination">To be added.</param>
551-
<param name="bytesWritten">To be added.</param>
552-
<param name="format">To be added.</param>
553-
<param name="provider">To be added.</param>
554-
<summary>To be added.</summary>
555-
<returns>To be added.</returns>
550+
<param name="utf8Destination">The span in which to write this instance's value formatted as a span of bytes.</param>
551+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <paramref name="utf8Destination" />.</param>
552+
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <paramref name="utf8Destination" />.</param>
553+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="utf8Destination" />.</param>
554+
<summary>Tries to format the value of the current instance as UTF-8 into the provided span of bytes.</summary>
555+
<returns>
556+
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
556557
<remarks>To be added.</remarks>
557558
</Docs>
558559
</Member>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
</AssemblyInfo>
5454
<Parameters />
5555
<Docs>
56-
<summary>To be added.</summary>
56+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.Marshalling.ComExposedClassAttribute`1" /> class.</summary>
5757
<remarks>To be added.</remarks>
5858
</Docs>
5959
</Member>
@@ -78,11 +78,11 @@
7878
<Parameter Name="count" Type="System.Int32" RefType="out" />
7979
</Parameters>
8080
<Docs>
81-
<param name="count">To be added.</param>
82-
<summary>To be added.</summary>
83-
<returns>To be added.</returns>
81+
<param name="count">The number of COM interfaces this type implements.</param>
82+
<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>
83+
<returns>The interface entry information for the interfaces the type implements.</returns>
8484
<remarks>To be added.</remarks>
85-
<inheritdoc />
85+
<inheritdoc cref="M:System.Runtime.InteropServices.Marshalling.IComExposedDetails.GetComInterfaceEntries(System.Int32@)" />
8686
</Docs>
8787
</Member>
8888
</Members>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
</Attribute>
4444
</Attributes>
4545
<Docs>
46-
<typeparam name="T">To be added.</typeparam>
46+
<typeparam name="T">The managed type that represents a COM interface type</typeparam>
4747
<summary>Marshals a COM interface using a <see cref="T:System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers" /> instance.</summary>
4848
<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>
@@ -114,8 +114,8 @@
114114
<Parameter Name="unmanaged" Type="System.Void*" />
115115
</Parameters>
116116
<Docs>
117-
<param name="unmanaged">To be added.</param>
118-
<summary>To be added.</summary>
117+
<param name="unmanaged">A COM interface pointer.</param>
118+
<summary>Releases a reference to the COM interface pointer.</summary>
119119
<remarks>To be added.</remarks>
120120
</Docs>
121121
</Member>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</Attribute>
2020
</Attributes>
2121
<Docs>
22-
<summary>To be added.</summary>
22+
<summary>Options for how to generate COM interface interop with the COM interop source generator.</summary>
2323
<remarks>To be added.</remarks>
2424
</Docs>
2525
<Members>
@@ -40,7 +40,7 @@
4040
</ReturnValue>
4141
<MemberValue>2</MemberValue>
4242
<Docs>
43-
<summary>To be added.</summary>
43+
<summary>Generate a wrapper for COM objects to enable exposing them through the managed interface.</summary>
4444
</Docs>
4545
</Member>
4646
<Member MemberName="ManagedObjectWrapper">
@@ -60,7 +60,7 @@
6060
</ReturnValue>
6161
<MemberValue>1</MemberValue>
6262
<Docs>
63-
<summary>To be added.</summary>
63+
<summary>Generate a wrapper for managed objects to enable exposing them through the COM interface.</summary>
6464
</Docs>
6565
</Member>
6666
<Member MemberName="None">
@@ -86,7 +86,7 @@
8686
</ReturnValue>
8787
<MemberValue>0</MemberValue>
8888
<Docs>
89-
<summary>To be added.</summary>
89+
<summary>No options specified.</summary>
9090
</Docs>
9191
</Member>
9292
</Members>

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@
126126
<returns>
127127
<see langword="true" /> if this object can be cast to the given interface; otherwise, <see langword="false" />.</returns>
128128
<remarks>To be added.</remarks>
129+
<inheritdoc />
129130
</Docs>
130131
</Member>
131132
<Member MemberName="System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider.GetVirtualMethodTableInfoForKey">
@@ -154,6 +155,7 @@
154155
<summary>Get the information about the virtual method table for a given unmanaged interface type represented by <paramref name="type" />.</summary>
155156
<returns>The virtual method table information for the unmanaged interface.</returns>
156157
<remarks>To be added.</remarks>
158+
<inheritdoc />
157159
</Docs>
158160
</Member>
159161
</Members>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</AssemblyInfo>
3838
<Parameters />
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.Marshalling.GeneratedComClassAttribute" /> class.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
</Member>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</AssemblyInfo>
3838
<Parameters />
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.Marshalling.GeneratedComInterfaceAttribute" /> class.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
</Member>
@@ -57,9 +57,9 @@
5757
<ReturnType>System.Runtime.InteropServices.Marshalling.ComInterfaceOptions</ReturnType>
5858
</ReturnValue>
5959
<Docs>
60-
<summary>To be added.</summary>
60+
<summary>Options for how to generate COM interface interop with the COM interop source generator.</summary>
6161
<value>To be added.</value>
62-
<remarks>To be added.</remarks>
62+
<remarks>The default options generate both a managed object wrapper and a COM object wrapper.</remarks>
6363
</Docs>
6464
</Member>
6565
<Member MemberName="StringMarshalling">

0 commit comments

Comments
 (0)