Skip to content
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

Port System.Buffers new docs (second pass) #10212

Merged
merged 4 commits into from
Aug 7, 2024
Merged

Port System.Buffers new docs (second pass) #10212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
489f26e
System.Buffers
carlossanlop Aug 6, 2024
0fc2f4f
System.Buffers.Binary
carlossanlop Aug 6, 2024
d725844
System.Buffers.Text
carlossanlop Aug 6, 2024
2bbe11c
Fix paramrefs
carlossanlop Aug 7, 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
54 changes: 27 additions & 27 deletions xml/System.Buffers.Binary/BinaryPrimitives.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1655,9 +1655,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.Int128&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down Expand Up @@ -1686,9 +1686,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.Int16&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down Expand Up @@ -1717,9 +1717,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.Int32&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down Expand Up @@ -1748,9 +1748,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.Int64&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down Expand Up @@ -1779,9 +1779,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.IntPtr&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down Expand Up @@ -1816,9 +1816,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.UInt128&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down Expand Up @@ -1890,9 +1890,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.UInt32&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down Expand Up @@ -1927,9 +1927,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.UInt64&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down Expand Up @@ -1964,9 +1964,9 @@ This method effectively does nothing and was added only for consistency.
<Parameter Name="destination" Type="System.Span&lt;System.UIntPtr&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="source">The source span to copy.</param>
<param name="destination">The destination to which the source elements should be copied.</param>
<summary>Copies every primitive value from <paramref name="source" /> to <paramref name="destination" />, reversing each primitive by performing an endianness swap as part of writing each.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
</Docs>
Expand Down
Loading