Skip to content

Commit 503d60d

Browse files
Anipikmairaw
andcommitted
Adding docs for Unsafe Apis in System.Runtime.CompilerServices (#2819)
* adding docs * summary on one line and comppare -> compare * adding specified prefix Co-Authored-By: Maira Wenzel <[email protected]>
1 parent 30ab2e0 commit 503d60d

File tree

1 file changed

+22
-25
lines changed

1 file changed

+22
-25
lines changed

xml/System.Runtime.CompilerServices/Unsafe.xml

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@
4949
<Parameter Name="elementOffset" Type="System.Int32" Index="1" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;netcore-3.0" />
5050
</Parameters>
5151
<Docs>
52-
<typeparam name="T">To be added.</typeparam>
53-
<param name="source">To be added.</param>
54-
<param name="elementOffset">To be added.</param>
55-
<summary>To be added.</summary>
56-
<returns>To be added.</returns>
52+
<typeparam name="T">The type of void pointer.</typeparam>
53+
<param name="source">The void pointer to add the offset to.</param>
54+
<param name="elementOffset">The offset to add.</param>
55+
<summary>Adds an element offset to the given void pointer.</summary>
56+
<returns>A new void pointer that reflects the addition of offset to the specified pointer.</returns>
5757
<remarks>To be added.</remarks>
5858
</Docs>
5959
</Member>
@@ -185,9 +185,7 @@
185185
<typeparam name="T">The type of reference.</typeparam>
186186
<param name="left">The first reference to compare.</param>
187187
<param name="right">The second reference to compare.</param>
188-
<summary>
189-
Determines whether the specified references point to the same location.
190-
</summary>
188+
<summary>Determines whether the specified references point to the same location.</summary>
191189
<returns>
192190
<see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> point to the same location; otherwise, <see langword="false" />.</returns>
193191
<remarks>To be added.</remarks>
@@ -764,11 +762,11 @@
764762
<Parameter Name="right" Type="T" RefType="ref" Index="1" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;netcore-3.0" />
765763
</Parameters>
766764
<Docs>
767-
<typeparam name="T">To be added.</typeparam>
768-
<param name="left">To be added.</param>
769-
<param name="right">To be added.</param>
770-
<summary>To be added.</summary>
771-
<returns>To be added.</returns>
765+
<typeparam name="T">The type of the reference.</typeparam>
766+
<param name="left">The first value to compare.</param>
767+
<param name="right">The second value to compare.</param>
768+
<summary>Returns a value that indicates whether a specified reference is greater than another specified reference.</summary>
769+
<returns><see langword="true" /> if <paramref name="left" /> is greater than <paramref name="right" />; otherwise, <see langword="false" />.</returns>
772770
<remarks>To be added.</remarks>
773771
</Docs>
774772
</Member>
@@ -797,11 +795,11 @@
797795
<Parameter Name="right" Type="T" RefType="ref" Index="1" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;netcore-3.0" />
798796
</Parameters>
799797
<Docs>
800-
<typeparam name="T">To be added.</typeparam>
801-
<param name="left">To be added.</param>
802-
<param name="right">To be added.</param>
803-
<summary>To be added.</summary>
804-
<returns>To be added.</returns>
798+
<typeparam name="T">The type of the reference.</typeparam>
799+
<param name="left">The first value to compare.</param>
800+
<param name="right">The second value to compare.</param>
801+
<summary>Returns a value that indicates whether a specified reference is less than another specified reference.</summary>
802+
<returns><see langword="true" /> if <paramref name="left" /> is less than <paramref name="right" />; otherwise, <see langword="false" />.</returns>
805803
<remarks>To be added.</remarks>
806804
</Docs>
807805
</Member>
@@ -964,11 +962,11 @@
964962
<Parameter Name="elementOffset" Type="System.Int32" Index="1" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;netcore-3.0" />
965963
</Parameters>
966964
<Docs>
967-
<typeparam name="T">To be added.</typeparam>
968-
<param name="source">To be added.</param>
969-
<param name="elementOffset">To be added.</param>
970-
<summary>To be added.</summary>
971-
<returns>To be added.</returns>
965+
<typeparam name="T">The type of the void pointer.</typeparam>
966+
<param name="source">The void pointer to subtract the offset from.</param>
967+
<param name="elementOffset">The offset to subtract.</param>
968+
<summary>Subtracts an element offset from the given void pointer.</summary>
969+
<returns>A new void pointer that reflects the subtraction of offset from the specified pointer.</returns>
972970
<remarks>To be added.</remarks>
973971
</Docs>
974972
</Member>
@@ -1062,8 +1060,7 @@
10621060
<Docs>
10631061
<typeparam name="T">The type of reference.</typeparam>
10641062
<param name="source">The reference to subtract the offset from.</param>
1065-
<param name="bytesOffset">The offset to subtract.</param>
1066-
<param name="byteOffset">To be added.</param>
1063+
<param name="byteOffset">The offset to subtract.</param>
10671064
<summary>
10681065
Subtracts a byte offset from the given reference.
10691066
</summary>

0 commit comments

Comments
 (0)