Skip to content

Commit 259fed3

Browse files
authored
Add remaining missing docs in System (dotnet#10373)
* Add remaining missing docs in System * Apply review comment
1 parent 199c28d commit 259fed3

File tree

5 files changed

+28
-22
lines changed

5 files changed

+28
-22
lines changed

xml/System/Delegate+InvocationListEnumerator`1.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@
8585
</ReturnValue>
8686
<Parameters />
8787
<Docs>
88-
<summary>Implements IEnumerable.GetEnumerator() to return 'this' as the IEnumerator.</summary>
89-
<returns>To be added.</returns>
88+
<summary>Implements IEnumerable.GetEnumerator() to return 'this' as the IEnumerator.</summary>
89+
<returns>An IEnumerator instance that can be used to iterate through the invocation targets of the delegate.</returns>
9090
<remarks>To be added.</remarks>
9191
</Docs>
9292
</Member>
@@ -108,7 +108,7 @@
108108
<Parameters />
109109
<Docs>
110110
<summary>Implements the IEnumerator pattern.</summary>
111-
<returns>To be added.</returns>
111+
<returns><see langword="true" /> if the enumerator was successfully advanced to the next element; otherwise, <see langword="false" /> if the enumerator has passed the end of the collection. </returns>
112112
<remarks>To be added.</remarks>
113113
</Docs>
114114
</Member>

xml/System/Delegate.xml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1878,13 +1878,11 @@ The number, order, or type of parameters listed in <paramref name="args" /> is i
18781878
</Parameter>
18791879
</Parameters>
18801880
<Docs>
1881-
<typeparam name="TDelegate">To be added.</typeparam>
1882-
<param name="d">To be added.</param>
1881+
<typeparam name="TDelegate">Delegate type being enumerated.</typeparam>
1882+
<param name="d">The delegate being enumerated.</param>
18831883
<summary>Gets an enumerator for the invocation targets of this delegate.</summary>
1884-
<returns>To be added.</returns>
1885-
<remarks>This method returns a <see cref="T:System.Delegate.InvocationListEnumerator`1" /> that follows the IEnumerable pattern and thus can be used in a C# 'foreach' statement to retrieve the invocation targets of this delegate without allocations.
1886-
The order of the delegates returned by the enumerator is the same order in which the current delegate invokes the methods that those delegates represent.
1887-
The method returns an empty enumerator for <see langword="null" /> delegate.</remarks>
1884+
<returns>A <see cref="T:System.Delegate.InvocationListEnumerator`1" /> that follows the IEnumerable pattern and thus can be used in a C# 'foreach' statement to retrieve the invocation targets of this delegate without allocations. The method returns an empty enumerator for <see langword="null" /> delegate.</returns>
1885+
<remarks>The order of the delegates returned by the enumerator is the same order in which the current delegate invokes the methods that those delegates represent.</remarks>
18881886
</Docs>
18891887
</Member>
18901888
<Member MemberName="Equals">

xml/System/MemoryExtensions+SpanSplitEnumerator`1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
</Attribute>
3535
</Attributes>
3636
<Docs>
37-
<typeparam name="T">To be added.</typeparam>
37+
<typeparam name="T">The type of items in the <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" />.</typeparam>
3838
<summary>Enables enumerating each split within a <see cref="T:System.ReadOnlySpan`1" /> that has been divided using one or more separators.</summary>
3939
<remarks>To be added.</remarks>
4040
</Docs>

xml/System/MemoryExtensions.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4368,11 +4368,11 @@ If `source` and `destination` overlap, this method behaves as if the original va
43684368
</Parameter>
43694369
</Parameters>
43704370
<Docs>
4371-
<typeparam name="T">To be added.</typeparam>
4371+
<typeparam name="T">The type of elements in the span.</typeparam>
43724372
<param name="span">The span to search.</param>
43734373
<param name="value">The value to compare.</param>
43744374
<summary>Determines whether the specified value appears at the end of the span.</summary>
4375-
<returns>To be added.</returns>
4375+
<returns><see langword="true" /> if <paramref name="value" /> matches the end of <paramref name="span" />; otherwise, <see langword="false" />.</returns>
43764376
<remarks>To be added.</remarks>
43774377
</Docs>
43784378
</Member>
@@ -4964,7 +4964,7 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
49644964
<param name="span">The span to search.</param>
49654965
<param name="values">The set of values to search for.</param>
49664966
<summary>Searches for the first index of any of the specified substring values.</summary>
4967-
<returns>To be added.</returns>
4967+
<returns>The first index of any of the specified values, or -1 if none are found.</returns>
49684968
<remarks>To be added.</remarks>
49694969
</Docs>
49704970
</Member>
@@ -5001,7 +5001,7 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
50015001
<param name="span">The span to search.</param>
50025002
<param name="values">The set of values to search for.</param>
50035003
<summary>Searches for the first index of any of the specified substring values.</summary>
5004-
<returns>To be added.</returns>
5004+
<returns>The first index of any of the specified values, or -1 if none are found.</returns>
50055005
<remarks>To be added.</remarks>
50065006
</Docs>
50075007
</Member>
@@ -9787,11 +9787,11 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
97879787
</Parameter>
97889788
</Parameters>
97899789
<Docs>
9790-
<typeparam name="T">To be added.</typeparam>
9790+
<typeparam name="T">The type of elements in the span.</typeparam>
97919791
<param name="span">The span to search.</param>
97929792
<param name="value">The value to compare.</param>
97939793
<summary>Determines whether the specified value appears at the start of the span.</summary>
9794-
<returns>To be added.</returns>
9794+
<returns><see langword="true" /> if <paramref name="value" /> matches the beginning of <paramref name="span" />; otherwise, <see langword="false" />.</returns>
97959795
<remarks>To be added.</remarks>
97969796
</Docs>
97979797
</Member>

xml/System/Type.xml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6135,12 +6135,20 @@ One of the elements in the <paramref name="types" /> array is <see langword="nul
61356135
<Parameter Name="types" Type="System.Type[]" Index="3" FrameworkAlternate="net-9.0" />
61366136
</Parameters>
61376137
<Docs>
6138-
<param name="name">To be added.</param>
6139-
<param name="genericParameterCount">To be added.</param>
6140-
<param name="bindingAttr">To be added.</param>
6141-
<param name="types">To be added.</param>
6142-
<summary>To be added.</summary>
6143-
<returns>To be added.</returns>
6138+
<param name="name">The string containing the name of the method to get.</param>
6139+
<param name="genericParameterCount">The number of generic type parameters of the method.</param>
6140+
<param name="bindingAttr">A bitwise combination of the enumeration values that specify how the search is conducted.
6141+
6142+
-or-
6143+
6144+
<see cref="F:System.Reflection.BindingFlags.Default" /> to return <see langword="null" />.</param>
6145+
<param name="types">An array of <see cref="T:System.Type" /> objects representing the number, order, and type of the parameters for the method to get.
6146+
6147+
-or-
6148+
6149+
An empty array of <see cref="T:System.Type" /> objects (as provided by the <see cref="F:System.Type.EmptyTypes" /> field) to get a method that takes no parameters.</param>
6150+
<summary>Searches for the specified method whose parameters match the specified generic parameter count and argument types, using the specified binding constraints.</summary>
6151+
<returns>An object representing the method that matches the specified generic parameter count, argument types, and binding constraints, if found; otherwise, <see langword="null" />.</returns>
61446152
<remarks>To be added.</remarks>
61456153
</Docs>
61466154
</Member>

0 commit comments

Comments
 (0)