Skip to content

Port Microsoft.Extensions.Primitives new docs #10169

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.

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
Changes from 3 commits
Commits
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
64 changes: 32 additions & 32 deletions xml/Microsoft.Extensions.Primitives/StringValues.xml
Original file line number Diff line number Diff line change
Expand Up @@ -275,12 +275,12 @@
<Docs>
<summary>A readonly instance of the <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> struct whose value is an empty string array.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
In application code, this field is most commonly used to safely represent a <xref:Microsoft.Extensions.Primitives.StringValues> that has `null` string values.
<format type="text/markdown"><![CDATA[

## Remarks

In application code, this field is most commonly used to safely represent a <xref:Microsoft.Extensions.Primitives.StringValues> that has `null` string values.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -729,8 +729,8 @@ In application code, this field is most commonly used to safely represent a <xre
<Parameter Name="right" Type="System.String" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<param name="left">The <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Primitives.StringValues"></xref> to compare.</param>
<param name="right">The <xref data-throw-if-not-resolved="true" uid="System.String"></xref> to compare.</param>
<summary>Determines whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> and <see cref="T:System.String" /> objects have the same values.</summary>
<returns>
<see langword="true" /> if the value of <paramref name="left" /> is the same as the value of <paramref name="right" />; otherwise, <see langword="false" />. If <paramref name="right" /> is <see langword="null" />, the method returns <see langword="false" />.</returns>
Expand Down Expand Up @@ -759,8 +759,8 @@ In application code, this field is most commonly used to safely represent a <xre
<Parameter Name="right" Type="System.String[]" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<param name="left">The <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Primitives.StringValues"></xref> to compare.</param>
<param name="right">The string array to compare.</param>
<summary>Determines whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> and string array objects have the same values.</summary>
<returns>
<see langword="true" /> if the value of <paramref name="left" /> is the same as the value of <paramref name="right" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -818,8 +818,8 @@ In application code, this field is most commonly used to safely represent a <xre
<Parameter Name="right" Type="Microsoft.Extensions.Primitives.StringValues" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<param name="left">The string to compare.</param>
<param name="right">The <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Primitives.StringValues"></xref> to compare.</param>
<summary>Determines whether the specified <see cref="T:System.String" /> and <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> objects have the same values.</summary>
<returns>
<see langword="true" /> if the value of <paramref name="left" /> is the same as the value of <paramref name="right" />; otherwise, <see langword="false" />. If <paramref name="left" /> is <see langword="null" />, the method returns <see langword="false" />.</returns>
Expand Down Expand Up @@ -848,8 +848,8 @@ In application code, this field is most commonly used to safely represent a <xre
<Parameter Name="right" Type="Microsoft.Extensions.Primitives.StringValues" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<param name="left">The string array to compare.</param>
<param name="right">The <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Primitives.StringValues"></xref> to compare.</param>
<summary>Determines whether the specified string array and <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> objects have the same values.</summary>
<returns>
<see langword="true" /> if the value of <paramref name="left" /> is the same as the value of <paramref name="right" />; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -881,12 +881,12 @@ In application code, this field is most commonly used to safely represent a <xre
<summary>Defines an implicit conversion of a given <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> to a string, with multiple values joined as a comma separated string.</summary>
<returns>Returns <see langword="null" /> where <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> has been initialized from an empty string array or is <see cref="P:Microsoft.Extensions.Primitives.StringValues.Empty" />. Otherwise, it returns the implicit conversion of <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> to a string.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Returns `null` where <xref:Microsoft.Extensions.Primitives.StringValues> has been initialized from an empty string array or is <xref:Microsoft.Extensions.Primitives.StringValues.Empty>.
<format type="text/markdown"><![CDATA[

## Remarks

Returns `null` where <xref:Microsoft.Extensions.Primitives.StringValues> has been initialized from an empty string array or is <xref:Microsoft.Extensions.Primitives.StringValues.Empty>.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -1514,12 +1514,12 @@ Returns `null` where <xref:Microsoft.Extensions.Primitives.StringValues> has bee
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
<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.StringValues> instance is cast to an <xref:System.Collections.IEnumerable> interface.
<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.StringValues> instance is cast to an <xref:System.Collections.IEnumerable> interface.

]]></format>
</remarks>
<inheritdoc cref="M:Microsoft.Extensions.Primitives.StringValues.GetEnumerator" />
Expand All @@ -1546,12 +1546,12 @@ This member is an explicit interface member implementation. It can be used only
<summary>Creates a string array from the current <see cref="T:Microsoft.Extensions.Primitives.StringValues" /> object.</summary>
<returns>A string array represented by this instance.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the <xref:Microsoft.Extensions.Primitives.StringValues> contains a single string internally, it is copied to a new array.If the <xref:Microsoft.Extensions.Primitives.StringValues> contains an array internally it returns that array instance.
<format type="text/markdown"><![CDATA[

## Remarks

If the <xref:Microsoft.Extensions.Primitives.StringValues> contains a single string internally, it is copied to a new array.If the <xref:Microsoft.Extensions.Primitives.StringValues> contains an array internally it returns that array instance.

]]></format>
</remarks>
</Docs>
Expand Down