Skip to content

Commit 8f6e317

Browse files
maryamariyanmaryamariyan
committed
Adds docs for Microsoft.Extensions.Primitives
1 parent 6560aff commit 8f6e317

File tree

8 files changed

+310
-201
lines changed

8 files changed

+310
-201
lines changed

‎xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="CancellationChangeToken" FullName="Microsoft.Extensions.Primitives.CancellationChangeToken">
1+
<Type Name="CancellationChangeToken" FullName="Microsoft.Extensions.Primitives.CancellationChangeToken">
22
<TypeSignature Language="C#" Value="public class CancellationChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CancellationChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.CancellationChangeToken" />
@@ -83,7 +83,7 @@
8383
<ReturnType>System.Boolean</ReturnType>
8484
</ReturnValue>
8585
<Docs>
86-
<summary>To be added.</summary>
86+
<summary>Indicates if this token will pro-actively raise callbacks. If <see langword="false" />, the token consumer must poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.</summary>
8787
<value>To be added.</value>
8888
<remarks>To be added.</remarks>
8989
<inheritdoc />
@@ -115,7 +115,7 @@
115115
<ReturnType>System.Boolean</ReturnType>
116116
</ReturnValue>
117117
<Docs>
118-
<summary>To be added.</summary>
118+
<summary>Gets a value that indicates if a change has occurred.</summary>
119119
<value>To be added.</value>
120120
<remarks>To be added.</remarks>
121121
<inheritdoc />
@@ -153,8 +153,9 @@
153153
<Docs>
154154
<param name="callback">To be added.</param>
155155
<param name="state">To be added.</param>
156-
<summary>To be added.</summary>
157-
<returns>To be added.</returns>
156+
<summary>Registers for a callback that will be invoked when the entry has changed.
157+
<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> MUST be set before the callback is invoked.</summary>
158+
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
158159
<remarks>To be added.</remarks>
159160
<inheritdoc />
160161
</Docs>

‎xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="CompositeChangeToken" FullName="Microsoft.Extensions.Primitives.CompositeChangeToken">
1+
<Type Name="CompositeChangeToken" FullName="Microsoft.Extensions.Primitives.CompositeChangeToken">
22
<TypeSignature Language="C#" Value="public class CompositeChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CompositeChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />
@@ -77,7 +77,7 @@
7777
<ReturnType>System.Boolean</ReturnType>
7878
</ReturnValue>
7979
<Docs>
80-
<summary>To be added.</summary>
80+
<summary>Indicates if this token will pro-actively raise callbacks. If <see langword="false" />, the token consumer must poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.</summary>
8181
<value>To be added.</value>
8282
<remarks>To be added.</remarks>
8383
<inheritdoc />
@@ -133,7 +133,7 @@
133133
<ReturnType>System.Boolean</ReturnType>
134134
</ReturnValue>
135135
<Docs>
136-
<summary>To be added.</summary>
136+
<summary>Gets a value that indicates if a change has occurred.</summary>
137137
<value>To be added.</value>
138138
<remarks>To be added.</remarks>
139139
<inheritdoc />
@@ -169,8 +169,9 @@
169169
<Docs>
170170
<param name="callback">To be added.</param>
171171
<param name="state">To be added.</param>
172-
<summary>To be added.</summary>
173-
<returns>To be added.</returns>
172+
<summary>Registers for a callback that will be invoked when the entry has changed.
173+
<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> MUST be set before the callback is invoked.</summary>
174+
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
174175
<remarks>To be added.</remarks>
175176
<inheritdoc />
176177
</Docs>

‎xml/Microsoft.Extensions.Primitives/StringSegment.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="StringSegment" FullName="Microsoft.Extensions.Primitives.StringSegment">
1+
<Type Name="StringSegment" FullName="Microsoft.Extensions.Primitives.StringSegment">
22
<TypeSignature Language="C#" Value="public struct StringSegment : IEquatable&lt;Microsoft.Extensions.Primitives.StringSegment&gt;, IEquatable&lt;string&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit StringSegment extends System.ValueType implements class System.IEquatable`1&lt;string&gt;, class System.IEquatable`1&lt;valuetype Microsoft.Extensions.Primitives.StringSegment&gt;" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.StringSegment" />
@@ -991,8 +991,8 @@
991991
<Parameter Name="segment" Type="Microsoft.Extensions.Primitives.StringSegment" Index="0" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0" />
992992
</Parameters>
993993
<Docs>
994-
<param name="segment">To be added.</param>
995-
<summary>To be added.</summary>
994+
<param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to convert to a <see cref="T:System.ReadOnlyMemory`1" />.</param>
995+
<summary>Creates a see <see cref="T:System.ReadOnlyMemory`1" /> from the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
996996
<returns>To be added.</returns>
997997
<remarks>To be added.</remarks>
998998
</Docs>
@@ -1020,8 +1020,8 @@
10201020
<Parameter Name="segment" Type="Microsoft.Extensions.Primitives.StringSegment" Index="0" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0" />
10211021
</Parameters>
10221022
<Docs>
1023-
<param name="segment">To be added.</param>
1024-
<summary>To be added.</summary>
1023+
<param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to convert to a <see cref="T:System.ReadOnlySpan`1" />.</param>
1024+
<summary>Creates a see <see cref="T:System.ReadOnlySpan`1" /> from the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
10251025
<returns>To be added.</returns>
10261026
<remarks>To be added.</remarks>
10271027
</Docs>

‎xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml‎

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="StringSegmentComparer" FullName="Microsoft.Extensions.Primitives.StringSegmentComparer">
1+
<Type Name="StringSegmentComparer" FullName="Microsoft.Extensions.Primitives.StringSegmentComparer">
22
<TypeSignature Language="C#" Value="public class StringSegmentComparer : System.Collections.Generic.IEqualityComparer&lt;Microsoft.Extensions.Primitives.StringSegment&gt;" FrameworkAlternate="dotnet-plat-ext-2.0;dotnet-plat-ext-2.1" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit StringSegmentComparer extends System.Object implements class System.Collections.Generic.IEqualityComparer`1&lt;valuetype Microsoft.Extensions.Primitives.StringSegment&gt;" FrameworkAlternate="dotnet-plat-ext-2.0;dotnet-plat-ext-2.1" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.StringSegmentComparer" />
@@ -61,10 +61,19 @@
6161
<Parameter Name="y" Type="Microsoft.Extensions.Primitives.StringSegment" Index="1" FrameworkAlternate="dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0" />
6262
</Parameters>
6363
<Docs>
64-
<param name="x">To be added.</param>
65-
<param name="y">To be added.</param>
66-
<summary>To be added.</summary>
67-
<returns>To be added.</returns>
64+
<param name="x">The first object to compare.</param>
65+
<param name="y">The second object to compare.</param>
66+
<summary>Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.</summary>
67+
<returns>A signed integer that indicates the relative values of <paramref name="x" /> and <paramref name="y" />, as shown in the following table.
68+
<list type="table"><listheader><term> Value
69+
</term><description> Meaning
70+
</description></listheader><item><term> Less than zero
71+
</term><description><paramref name="x" /> is less than <paramref name="y" />.
72+
</description></item><item><term> Zero
73+
</term><description><paramref name="x" /> equals <paramref name="y" />.
74+
</description></item><item><term> Greater than zero
75+
</term><description><paramref name="x" /> is greater than <paramref name="y" />.
76+
</description></item></list></returns>
6877
<remarks>To be added.</remarks>
6978
</Docs>
7079
</Member>
@@ -96,10 +105,11 @@
96105
<Parameter Name="y" Type="Microsoft.Extensions.Primitives.StringSegment" />
97106
</Parameters>
98107
<Docs>
99-
<param name="x">To be added.</param>
100-
<param name="y">To be added.</param>
101-
<summary>To be added.</summary>
102-
<returns>To be added.</returns>
108+
<param name="x">The first object of type <paramref name="T" /> to compare.</param>
109+
<param name="y">The second object of type <paramref name="T" /> to compare.</param>
110+
<summary>Determines whether the specified objects are equal.</summary>
111+
<returns>
112+
<see langword="true" /> if the specified objects are equal; otherwise, <see langword="false" />.</returns>
103113
<remarks>To be added.</remarks>
104114
</Docs>
105115
</Member>
@@ -130,9 +140,9 @@
130140
<Parameter Name="obj" Type="Microsoft.Extensions.Primitives.StringSegment" />
131141
</Parameters>
132142
<Docs>
133-
<param name="obj">To be added.</param>
134-
<summary>To be added.</summary>
135-
<returns>To be added.</returns>
143+
<param name="obj">The <see cref="T:System.Object" /> for which a hash code is to be returned.</param>
144+
<summary>Returns a hash code for the specified object.</summary>
145+
<returns>A hash code for the specified object.</returns>
136146
<remarks>To be added.</remarks>
137147
</Docs>
138148
</Member>

‎xml/Microsoft.Extensions.Primitives/StringTokenizer+Enumerator.xml‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="StringTokenizer+Enumerator" FullName="Microsoft.Extensions.Primitives.StringTokenizer+Enumerator">
1+
<Type Name="StringTokenizer+Enumerator" FullName="Microsoft.Extensions.Primitives.StringTokenizer+Enumerator">
22
<TypeSignature Language="C#" Value="public struct StringTokenizer.Enumerator : System.Collections.Generic.IEnumerator&lt;Microsoft.Extensions.Primitives.StringSegment&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class nested public sequential ansi sealed beforefieldinit StringTokenizer/Enumerator extends System.ValueType implements class System.Collections.Generic.IEnumerator`1&lt;valuetype Microsoft.Extensions.Primitives.StringSegment&gt;, class System.Collections.IEnumerator, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.StringTokenizer.Enumerator" />
@@ -94,8 +94,8 @@
9494
<ReturnType>Microsoft.Extensions.Primitives.StringSegment</ReturnType>
9595
</ReturnValue>
9696
<Docs>
97-
<summary>To be added.</summary>
98-
<value>To be added.</value>
97+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
98+
<value>The element in the collection at the current position of the enumerator.</value>
9999
<remarks>To be added.</remarks>
100100
</Docs>
101101
</Member>
@@ -126,7 +126,7 @@
126126
</ReturnValue>
127127
<Parameters />
128128
<Docs>
129-
<summary>To be added.</summary>
129+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
130130
<remarks>To be added.</remarks>
131131
</Docs>
132132
</Member>
@@ -157,8 +157,9 @@
157157
</ReturnValue>
158158
<Parameters />
159159
<Docs>
160-
<summary>To be added.</summary>
161-
<returns>To be added.</returns>
160+
<summary>Advances the enumerator to the next element of the collection.</summary>
161+
<returns>
162+
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
162163
<remarks>To be added.</remarks>
163164
</Docs>
164165
</Member>
@@ -189,7 +190,7 @@
189190
</ReturnValue>
190191
<Parameters />
191192
<Docs>
192-
<summary>To be added.</summary>
193+
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
193194
<remarks>To be added.</remarks>
194195
</Docs>
195196
</Member>
@@ -219,9 +220,17 @@
219220
<ReturnType>System.Object</ReturnType>
220221
</ReturnValue>
221222
<Docs>
222-
<summary>To be added.</summary>
223-
<value>To be added.</value>
224-
<remarks>To be added.</remarks>
223+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
224+
<value>The element in the collection at the current position of the enumerator.</value>
225+
<remarks>
226+
<format type="text/markdown"><![CDATA[
227+
228+
## Remarks
229+
230+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.Primitives.StringTokenizer.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
231+
232+
]]></format>
233+
</remarks>
225234
</Docs>
226235
</Member>
227236
</Members>

‎xml/Microsoft.Extensions.Primitives/StringTokenizer.xml‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="StringTokenizer" FullName="Microsoft.Extensions.Primitives.StringTokenizer">
1+
<Type Name="StringTokenizer" FullName="Microsoft.Extensions.Primitives.StringTokenizer">
22
<TypeSignature Language="C#" Value="public struct StringTokenizer : System.Collections.Generic.IEnumerable&lt;Microsoft.Extensions.Primitives.StringSegment&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit StringTokenizer extends System.ValueType implements class System.Collections.Generic.IEnumerable`1&lt;valuetype Microsoft.Extensions.Primitives.StringSegment&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.StringTokenizer" />
@@ -151,8 +151,8 @@
151151
</ReturnValue>
152152
<Parameters />
153153
<Docs>
154-
<summary>To be added.</summary>
155-
<returns>To be added.</returns>
154+
<summary>Returns an enumerator that iterates through the collection.</summary>
155+
<returns>An enumerator that can be used to iterate through the collection.</returns>
156156
<remarks>To be added.</remarks>
157157
</Docs>
158158
</Member>
@@ -183,9 +183,17 @@
183183
</ReturnValue>
184184
<Parameters />
185185
<Docs>
186-
<summary>To be added.</summary>
187-
<returns>To be added.</returns>
188-
<remarks>To be added.</remarks>
186+
<summary>Returns an enumerator that iterates through a collection.</summary>
187+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
188+
<remarks>
189+
<format type="text/markdown"><![CDATA[
190+
191+
## Remarks
192+
193+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.Primitives.StringTokenizer> instance is cast to an <xref:System.Collections.IEnumerable> interface.
194+
195+
]]></format>
196+
</remarks>
189197
</Docs>
190198
</Member>
191199
</Members>

‎xml/Microsoft.Extensions.Primitives/StringValues+Enumerator.xml‎

Lines changed: 39 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="StringValues+Enumerator" FullName="Microsoft.Extensions.Primitives.StringValues+Enumerator">
1+
<Type Name="StringValues+Enumerator" FullName="Microsoft.Extensions.Primitives.StringValues+Enumerator">
22
<TypeSignature Language="C#" Value="public struct StringValues.Enumerator : System.Collections.Generic.IEnumerator&lt;string&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class nested public sequential ansi sealed beforefieldinit StringValues/Enumerator extends System.ValueType implements class System.Collections.Generic.IEnumerator`1&lt;string&gt;, class System.Collections.IEnumerator, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.StringValues.Enumerator" />
@@ -31,7 +31,7 @@
3131
</Interface>
3232
</Interfaces>
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Enumerates the string values of a <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
<Members>
@@ -89,8 +89,8 @@
8989
<ReturnType>System.String</ReturnType>
9090
</ReturnValue>
9191
<Docs>
92-
<summary>To be added.</summary>
93-
<value>To be added.</value>
92+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
93+
<value>The element in the collection at the current position of the enumerator.</value>
9494
<remarks>To be added.</remarks>
9595
</Docs>
9696
</Member>
@@ -119,7 +119,7 @@
119119
</ReturnValue>
120120
<Parameters />
121121
<Docs>
122-
<summary>To be added.</summary>
122+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
123123
<remarks>To be added.</remarks>
124124
</Docs>
125125
</Member>
@@ -150,8 +150,9 @@
150150
</ReturnValue>
151151
<Parameters />
152152
<Docs>
153-
<summary>To be added.</summary>
154-
<returns>To be added.</returns>
153+
<summary>Advances the enumerator to the next element of the collection.</summary>
154+
<returns>
155+
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
155156
<remarks>To be added.</remarks>
156157
</Docs>
157158
</Member>
@@ -181,9 +182,17 @@
181182
<ReturnType>System.Object</ReturnType>
182183
</ReturnValue>
183184
<Docs>
184-
<summary>To be added.</summary>
185-
<value>To be added.</value>
186-
<remarks>To be added.</remarks>
185+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
186+
<value>The element in the collection at the current position of the enumerator.</value>
187+
<remarks>
188+
<format type="text/markdown"><![CDATA[
189+
190+
## Remarks
191+
192+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.Primitives.StringValues.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
193+
194+
]]></format>
195+
</remarks>
187196
</Docs>
188197
</Member>
189198
<Member MemberName="System.Collections.IEnumerator.Reset">
@@ -213,8 +222,16 @@
213222
</ReturnValue>
214223
<Parameters />
215224
<Docs>
216-
<summary>To be added.</summary>
217-
<remarks>To be added.</remarks>
225+
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
226+
<remarks>
227+
<format type="text/markdown"><![CDATA[
228+
229+
## Remarks
230+
231+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.Primitives.StringValues.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
232+
233+
]]></format>
234+
</remarks>
218235
</Docs>
219236
</Member>
220237
<Member MemberName="System.IDisposable.Dispose">
@@ -238,8 +255,16 @@
238255
</ReturnValue>
239256
<Parameters />
240257
<Docs>
241-
<summary>To be added.</summary>
242-
<remarks>To be added.</remarks>
258+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
259+
<remarks>
260+
<format type="text/markdown"><![CDATA[
261+
262+
## Remarks
263+
264+
This member is an explicit interface member implementation. It can be used only when the <xref:Microsoft.Extensions.Primitives.StringValues.Enumerator> instance is cast to an <xref:System.IDisposable> interface.
265+
266+
]]></format>
267+
</remarks>
243268
</Docs>
244269
</Member>
245270
</Members>

0 commit comments

Comments
 (0)