Skip to content

Port System.Text new docs #10159

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 2 commits into from
Jul 29, 2024
Merged

Port System.Text new docs #10159

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d56f79e
System.Text
carlossanlop Jul 25, 2024
6cd578c
Replace data-dev-comment-type xml items
carlossanlop Jul 29, 2024
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
22 changes: 12 additions & 10 deletions xml/System.Text/ASCIIEncoding.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1848,11 +1848,12 @@
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="chars">To be added.</param>
<param name="bytes">To be added.</param>
<param name="bytesWritten">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="chars">The span containing the set of characters to encode.</param>
<param name="bytes">The byte span to hold the encoded bytes.</param>
<param name="bytesWritten">Upon successful completion of the operation, the number of bytes encoded into <code data-dev-comment-type="paramref">bytes</code>.</param>
<summary>Encodes into a span of bytes a set of characters from the specified read-only span if the destination is large enough.</summary>
<returns>
<code data-dev-comment-type="langword">true</code> if all of the characters were encoded into the destination; <code data-dev-comment-type="langword">false</code> if the destination was too small to contain all the encoded bytes.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -1885,11 +1886,12 @@
<Parameter Name="charsWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="bytes">To be added.</param>
<param name="chars">To be added.</param>
<param name="charsWritten">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="bytes">A read-only span containing the sequence of bytes to decode.</param>
<param name="chars">The character span receiving the decoded bytes.</param>
<param name="charsWritten">Upon successful completion of the operation, the number of chars decoded into <code data-dev-comment-type="paramref">chars</code>.</param>
<summary>Decodes into a span of chars a set of bytes from the specified read-only span if the destination is large enough.</summary>
<returns>
<code data-dev-comment-type="langword">true</code> if all of the characters were decoded into the destination; <code data-dev-comment-type="langword">false</code> if the destination was too small to contain all the decoded chars.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
72 changes: 39 additions & 33 deletions xml/System.Text/Ascii.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,11 @@
<Parameter Name="right" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="left">The buffer to compare with <code data-dev-comment-type="paramref">right</code>.</param>
<param name="right">The buffer to compare with <code data-dev-comment-type="paramref">left</code>.</param>
<summary>Determines whether the provided buffers contain equal ASCII characters.</summary>
<returns>
<code data-dev-comment-type="langword">true</code> if the corresponding elements in <code data-dev-comment-type="paramref">left</code> and <code data-dev-comment-type="paramref">right</code> are equal and ASCII; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.Equals(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})" />
</Docs>
Expand All @@ -98,10 +99,11 @@
<Parameter Name="right" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="left">The buffer to compare with <code data-dev-comment-type="paramref">right</code>.</param>
<param name="right">The buffer to compare with <code data-dev-comment-type="paramref">left</code>.</param>
<summary>Determines whether the provided buffers contain equal ASCII characters.</summary>
<returns>
<code data-dev-comment-type="langword">true</code> if the corresponding elements in <code data-dev-comment-type="paramref">left</code> and <code data-dev-comment-type="paramref">right</code> are equal and ASCII; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.Equals(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Char})" />
</Docs>
Expand All @@ -127,10 +129,11 @@
<Parameter Name="right" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="left">The buffer to compare with <code data-dev-comment-type="paramref">right</code>.</param>
<param name="right">The buffer to compare with <code data-dev-comment-type="paramref">left</code>.</param>
<summary>Determines whether the provided buffers contain equal ASCII characters.</summary>
<returns>
<code data-dev-comment-type="langword">true</code> if the corresponding elements in <code data-dev-comment-type="paramref">left</code> and <code data-dev-comment-type="paramref">right</code> are equal and ASCII; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.Equals(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Char})" />
</Docs>
Expand Down Expand Up @@ -185,10 +188,11 @@
<Parameter Name="right" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="left">The buffer to compare with <code data-dev-comment-type="paramref">right</code>.</param>
<param name="right">The buffer to compare with <code data-dev-comment-type="paramref">left</code>.</param>
<summary>Determines whether the provided buffers contain equal ASCII characters, ignoring case considerations.</summary>
<returns>
<code data-dev-comment-type="langword">true</code> if the corresponding elements in <code data-dev-comment-type="paramref">left</code> and <code data-dev-comment-type="paramref">right</code> are equal ignoring case considerations and ASCII; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.EqualsIgnoreCase(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})" />
</Docs>
Expand All @@ -214,10 +218,11 @@
<Parameter Name="right" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="left">The buffer to compare with <code data-dev-comment-type="paramref">right</code>.</param>
<param name="right">The buffer to compare with <code data-dev-comment-type="paramref">left</code>.</param>
<summary>Determines whether the provided buffers contain equal ASCII characters, ignoring case considerations.</summary>
<returns>
<code data-dev-comment-type="langword">true</code> if the corresponding elements in <code data-dev-comment-type="paramref">left</code> and <code data-dev-comment-type="paramref">right</code> are equal ignoring case considerations and ASCII; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.EqualsIgnoreCase(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})" />
</Docs>
Expand All @@ -243,10 +248,11 @@
<Parameter Name="right" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="left">The buffer to compare with <code data-dev-comment-type="paramref">right</code>.</param>
<param name="right">The buffer to compare with <code data-dev-comment-type="paramref">left</code>.</param>
<summary>Determines whether the provided buffers contain equal ASCII characters, ignoring case considerations.</summary>
<returns>
<code data-dev-comment-type="langword">true</code> if the corresponding elements in <code data-dev-comment-type="paramref">left</code> and <code data-dev-comment-type="paramref">right</code> are equal ignoring case considerations and ASCII; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.EqualsIgnoreCase(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})" />
</Docs>
Expand Down Expand Up @@ -817,9 +823,9 @@
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The ASCII buffer.</param>
<summary>Trims all leading and trailing ASCII whitespaces from the buffer.</summary>
<returns>The range of the untrimmed data.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.Trim(System.ReadOnlySpan{System.Byte})" />
</Docs>
Expand Down Expand Up @@ -870,9 +876,9 @@
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The ASCII buffer.</param>
<summary>Trims all trailing ASCII whitespaces from the buffer.</summary>
<returns>The range of the untrimmed data.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.TrimEnd(System.ReadOnlySpan{System.Byte})" />
</Docs>
Expand Down Expand Up @@ -923,9 +929,9 @@
<Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The ASCII buffer.</param>
<summary>Trims all leading ASCII whitespaces from the buffer.</summary>
<returns>The range of the untrimmed data.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Text.Ascii.TrimStart(System.ReadOnlySpan{System.Byte})" />
</Docs>
Expand Down
Loading