Skip to content

Commit

Permalink
Port System.Buffers new docs (second pass) (#10212)
Browse files Browse the repository at this point in the history 
* System.Buffers

* System.Buffers.Binary

* System.Buffers.Text

* Fix paramrefs
  • Loading branch information
@carlossanlop
carlossanlop authored Aug 7, 2024
1 parent 14faa42 commit f8b0e7e
Show file tree
Hide file tree
Showing 5 changed files with 332 additions and 202 deletions.
54 changes: 27 additions & 27 deletions xml/System.Buffers.Binary/BinaryPrimitives.xml
View file
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

0 comments on commit f8b0e7e

Please sign in to comment.