Skip to content

Adds docs for Microsoft.Extensions.Primitives #4105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 13, 2020
Merged

Adds docs for Microsoft.Extensions.Primitives #4105

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8f6e317
Adds docs for Microsoft.Extensions.Primitives
maryamariyan Apr 14, 2020
36dbc33
PR feedback
maryamariyan Apr 14, 2020
09ecf9c
Add missing values
maryamariyan Apr 15, 2020
3b6a86e
Add for missing params and typeparams
maryamariyan Apr 15, 2020
7bdb807
Apply suggestions from code review
maryamariyan Apr 16, 2020
8675fe6
one liner change
maryamariyan Apr 23, 2020
7e5b858
Update xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml
maryamariyan Apr 23, 2020
ddd8f93
Update xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml
maryamariyan Apr 23, 2020
08d1858
Update xml/Microsoft.Extensions.Primitives/ChangeToken.xml
maryamariyan Apr 23, 2020
6237ce1
Update xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml
maryamariyan Apr 23, 2020
11fc4ba
Update xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml
maryamariyan Apr 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="CancellationChangeToken" FullName="Microsoft.Extensions.Primitives.CancellationChangeToken">
<Type Name="CancellationChangeToken" FullName="Microsoft.Extensions.Primitives.CancellationChangeToken">
<TypeSignature Language="C#" Value="public class CancellationChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CancellationChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.CancellationChangeToken" />
Expand Down Expand Up @@ -83,8 +83,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<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>
<value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -115,8 +115,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates if a change has occurred.</summary>
<value><see langword="true" /> if a change has occured; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -151,10 +151,10 @@
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="callback">To be added.</param>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
<param name="state">State to be passed into the callback.</param>
<summary>Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> must be set before the callback is invoked.</summary>
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Primitives/ChangeToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
<Parameter Name="state" Type="TState" />
</Parameters>
<Docs>
<typeparam name="TState">To be added.</typeparam>
<typeparam name="TState">The type of the state for the <paramref name="changeTokenConsumer" /> action.</typeparam>
<param name="changeTokenProducer">Produces the change token.</param>
<param name="changeTokenConsumer">Action called when the token changes.</param>
<param name="state">state for the consumer.</param>
Expand Down
20 changes: 10 additions & 10 deletions xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="CompositeChangeToken" FullName="Microsoft.Extensions.Primitives.CompositeChangeToken">
<Type Name="CompositeChangeToken" FullName="Microsoft.Extensions.Primitives.CompositeChangeToken">
<TypeSignature Language="C#" Value="public class CompositeChangeToken : Microsoft.Extensions.Primitives.IChangeToken" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CompositeChangeToken extends System.Object implements class Microsoft.Extensions.Primitives.IChangeToken" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />
Expand Down Expand Up @@ -77,8 +77,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<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>
<value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand All @@ -105,7 +105,7 @@
</ReturnValue>
<Docs>
<summary>Returns the list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> which compose the current <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />.</summary>
<value>To be added.</value>
<value>The list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> instances which compose the current <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -133,8 +133,8 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates if a change has occurred.</summary>
<value><see langword="true" /> if a change has occured; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -167,10 +167,10 @@
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="callback">To be added.</param>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="callback">The <see cref="T:System.Action`1" /> to invoke.</param>
<param name="state">State to be passed into the callback.</param>
<summary>Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> must be set before the callback is invoked.</summary>
<returns>An <see cref="T:System.IDisposable" /> that is used to unregister the callback.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Primitives/IChangeToken.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<Docs>
<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>
<value>To be added.</value>
<value><see langword="true" /> if the token will proactively raise callbacks; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -75,7 +75,7 @@
</ReturnValue>
<Docs>
<summary>Gets a value that indicates if a change has occurred.</summary>
<value>To be added.</value>
<value><see langword="true" /> if a change has occurred; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
22 changes: 12 additions & 10 deletions xml/Microsoft.Extensions.Primitives/StringSegment.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="StringSegment" FullName="Microsoft.Extensions.Primitives.StringSegment">
<Type Name="StringSegment" FullName="Microsoft.Extensions.Primitives.StringSegment">
<TypeSignature Language="C#" Value="public struct StringSegment : IEquatable&lt;Microsoft.Extensions.Primitives.StringSegment&gt;, IEquatable&lt;string&gt;" />
<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;" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.StringSegment" />
Expand Down Expand Up @@ -182,9 +182,11 @@
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.String" /> buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
<value>To be added.</value>
<value>The <see cref="T:System.String" /> buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</value>
<remarks>To be added.</remarks>
</Docs>
<summary>Gets the value of this segment as a <see cref="T:System.String" />.</summary>
<value>The value of this segment as a <see cref="T:System.String" />.</value>
</Member>
<Member MemberName="Compare">
<MemberSignature Language="C#" Value="public static int Compare (Microsoft.Extensions.Primitives.StringSegment a, Microsoft.Extensions.Primitives.StringSegment b, StringComparison comparisonType);" />
Expand Down Expand Up @@ -556,7 +558,7 @@
</ReturnValue>
<Docs>
<summary>Gets whether this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> contains a valid value.</summary>
<value>To be added.</value>
<value><see langword="true" /> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> contains a valid value; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -901,7 +903,7 @@
</ReturnValue>
<Docs>
<summary>Gets the length of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
<value>To be added.</value>
<value>The length of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -929,7 +931,7 @@
</ReturnValue>
<Docs>
<summary>Gets the offset within the buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
<value>To be added.</value>
<value>The offset within the buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -991,8 +993,8 @@
<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" />
</Parameters>
<Docs>
<param name="segment">To be added.</param>
<summary>To be added.</summary>
<param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to convert to a <see cref="T:System.ReadOnlyMemory`1" />.</param>
<summary>Creates a see <see cref="T:System.ReadOnlyMemory`1" /> from the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -1020,8 +1022,8 @@
<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" />
</Parameters>
<Docs>
<param name="segment">To be added.</param>
<summary>To be added.</summary>
<param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment" /> to convert to a <see cref="T:System.ReadOnlySpan`1" />.</param>
<summary>Creates a see <see cref="T:System.ReadOnlySpan`1" /> from the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -1450,7 +1452,7 @@
</ReturnValue>
<Docs>
<summary>Gets the value of this segment as a <see cref="T:System.String" />.</summary>
<value>To be added.</value>
<value>The value of this segment as a <see cref="T:System.String" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
34 changes: 22 additions & 12 deletions xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="StringSegmentComparer" FullName="Microsoft.Extensions.Primitives.StringSegmentComparer">
<Type Name="StringSegmentComparer" FullName="Microsoft.Extensions.Primitives.StringSegmentComparer">
<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" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.StringSegmentComparer" />
Expand Down Expand Up @@ -61,10 +61,19 @@
<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" />
</Parameters>
<Docs>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="x">The first object to compare.</param>
<param name="y">The second object to compare.</param>
<summary>Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.</summary>
<returns>A signed integer that indicates the relative values of <paramref name="x" /> and <paramref name="y" />, as shown in the following table.
<list type="table"><listheader><term> Value
</term><description> Meaning
</description></listheader><item><term> Less than zero
</term><description><paramref name="x" /> is less than <paramref name="y" />.
</description></item><item><term> Zero
</term><description><paramref name="x" /> equals <paramref name="y" />.
</description></item><item><term> Greater than zero
</term><description><paramref name="x" /> is greater than <paramref name="y" />.
</description></item></list></returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -96,10 +105,11 @@
<Parameter Name="y" Type="Microsoft.Extensions.Primitives.StringSegment" />
</Parameters>
<Docs>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="x">The first object of type <paramref name="T" /> to compare.</param>
<param name="y">The second object of type <paramref name="T" /> to compare.</param>
<summary>Determines whether the specified objects are equal.</summary>
<returns>
<see langword="true" /> if the specified objects are equal; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -130,9 +140,9 @@
<Parameter Name="obj" Type="Microsoft.Extensions.Primitives.StringSegment" />
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="obj">The <see cref="T:System.Object" /> for which a hash code is to be returned.</param>
<summary>Returns a hash code for the specified object.</summary>
<returns>A hash code for the specified object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
29 changes: 19 additions & 10 deletions xml/Microsoft.Extensions.Primitives/StringTokenizer+Enumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Type Name="StringTokenizer+Enumerator" FullName="Microsoft.Extensions.Primitives.StringTokenizer+Enumerator">
<Type Name="StringTokenizer+Enumerator" FullName="Microsoft.Extensions.Primitives.StringTokenizer+Enumerator">
<TypeSignature Language="C#" Value="public struct StringTokenizer.Enumerator : System.Collections.Generic.IEnumerator&lt;Microsoft.Extensions.Primitives.StringSegment&gt;" />
<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" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Primitives.StringTokenizer.Enumerator" />
Expand Down Expand Up @@ -94,8 +94,8 @@
<ReturnType>Microsoft.Extensions.Primitives.StringSegment</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
<value>The element in the collection at the current position of the enumerator.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -126,7 +126,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -157,8 +157,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Advances the enumerator to the next element of the collection.</summary>
<returns>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -189,7 +190,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -219,9 +220,17 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
<value>The element in the collection at the current position of the enumerator.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading