Skip to content

Commit f8b0e7e

Browse files
carlossanlopcarlossanlop
authored
Port System.Buffers new docs (second pass) (#10212)
* System.Buffers * System.Buffers.Binary * System.Buffers.Text * Fix paramrefs
1 parent 14faa42 commit f8b0e7e

File tree

5 files changed

+332
-202
lines changed

5 files changed

+332
-202
lines changed

‎xml/System.Buffers.Binary/BinaryPrimitives.xml

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1655,9 +1655,9 @@ This method effectively does nothing and was added only for consistency.
16551655
<Parameter Name="destination" Type="System.Span&lt;System.Int128&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
16561656
</Parameters>
16571657
<Docs>
1658-
<param name="source">To be added.</param>
1659-
<param name="destination">To be added.</param>
1660-
<summary>To be added.</summary>
1658+
<param name="source">The source span to copy.</param>
1659+
<param name="destination">The destination to which the source elements should be copied.</param>
1660+
<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>
16611661
<remarks>To be added.</remarks>
16621662
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
16631663
</Docs>
@@ -1686,9 +1686,9 @@ This method effectively does nothing and was added only for consistency.
16861686
<Parameter Name="destination" Type="System.Span&lt;System.Int16&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
16871687
</Parameters>
16881688
<Docs>
1689-
<param name="source">To be added.</param>
1690-
<param name="destination">To be added.</param>
1691-
<summary>To be added.</summary>
1689+
<param name="source">The source span to copy.</param>
1690+
<param name="destination">The destination to which the source elements should be copied.</param>
1691+
<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>
16921692
<remarks>To be added.</remarks>
16931693
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
16941694
</Docs>
@@ -1717,9 +1717,9 @@ This method effectively does nothing and was added only for consistency.
17171717
<Parameter Name="destination" Type="System.Span&lt;System.Int32&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
17181718
</Parameters>
17191719
<Docs>
1720-
<param name="source">To be added.</param>
1721-
<param name="destination">To be added.</param>
1722-
<summary>To be added.</summary>
1720+
<param name="source">The source span to copy.</param>
1721+
<param name="destination">The destination to which the source elements should be copied.</param>
1722+
<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>
17231723
<remarks>To be added.</remarks>
17241724
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
17251725
</Docs>
@@ -1748,9 +1748,9 @@ This method effectively does nothing and was added only for consistency.
17481748
<Parameter Name="destination" Type="System.Span&lt;System.Int64&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
17491749
</Parameters>
17501750
<Docs>
1751-
<param name="source">To be added.</param>
1752-
<param name="destination">To be added.</param>
1753-
<summary>To be added.</summary>
1751+
<param name="source">The source span to copy.</param>
1752+
<param name="destination">The destination to which the source elements should be copied.</param>
1753+
<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>
17541754
<remarks>To be added.</remarks>
17551755
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
17561756
</Docs>
@@ -1779,9 +1779,9 @@ This method effectively does nothing and was added only for consistency.
17791779
<Parameter Name="destination" Type="System.Span&lt;System.IntPtr&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
17801780
</Parameters>
17811781
<Docs>
1782-
<param name="source">To be added.</param>
1783-
<param name="destination">To be added.</param>
1784-
<summary>To be added.</summary>
1782+
<param name="source">The source span to copy.</param>
1783+
<param name="destination">The destination to which the source elements should be copied.</param>
1784+
<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>
17851785
<remarks>To be added.</remarks>
17861786
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
17871787
</Docs>
@@ -1816,9 +1816,9 @@ This method effectively does nothing and was added only for consistency.
18161816
<Parameter Name="destination" Type="System.Span&lt;System.UInt128&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
18171817
</Parameters>
18181818
<Docs>
1819-
<param name="source">To be added.</param>
1820-
<param name="destination">To be added.</param>
1821-
<summary>To be added.</summary>
1819+
<param name="source">The source span to copy.</param>
1820+
<param name="destination">The destination to which the source elements should be copied.</param>
1821+
<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>
18221822
<remarks>To be added.</remarks>
18231823
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
18241824
</Docs>
@@ -1890,9 +1890,9 @@ This method effectively does nothing and was added only for consistency.
18901890
<Parameter Name="destination" Type="System.Span&lt;System.UInt32&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
18911891
</Parameters>
18921892
<Docs>
1893-
<param name="source">To be added.</param>
1894-
<param name="destination">To be added.</param>
1895-
<summary>To be added.</summary>
1893+
<param name="source">The source span to copy.</param>
1894+
<param name="destination">The destination to which the source elements should be copied.</param>
1895+
<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>
18961896
<remarks>To be added.</remarks>
18971897
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
18981898
</Docs>
@@ -1927,9 +1927,9 @@ This method effectively does nothing and was added only for consistency.
19271927
<Parameter Name="destination" Type="System.Span&lt;System.UInt64&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
19281928
</Parameters>
19291929
<Docs>
1930-
<param name="source">To be added.</param>
1931-
<param name="destination">To be added.</param>
1932-
<summary>To be added.</summary>
1930+
<param name="source">The source span to copy.</param>
1931+
<param name="destination">The destination to which the source elements should be copied.</param>
1932+
<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>
19331933
<remarks>To be added.</remarks>
19341934
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
19351935
</Docs>
@@ -1964,9 +1964,9 @@ This method effectively does nothing and was added only for consistency.
19641964
<Parameter Name="destination" Type="System.Span&lt;System.UIntPtr&gt;" Index="1" FrameworkAlternate="net-8.0;net-9.0" />
19651965
</Parameters>
19661966
<Docs>
1967-
<param name="source">To be added.</param>
1968-
<param name="destination">To be added.</param>
1969-
<summary>To be added.</summary>
1967+
<param name="source">The source span to copy.</param>
1968+
<param name="destination">The destination to which the source elements should be copied.</param>
1969+
<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>
19701970
<remarks>To be added.</remarks>
19711971
<inheritdoc cref="M:System.Buffers.Binary.BinaryPrimitives.ReverseEndianness(System.ReadOnlySpan{System.UInt16},System.Span{System.UInt16})" />
19721972
</Docs>

0 commit comments

Comments
 (0)