Skip to content

Commit 77ac92a

Browse files
carlossanlopmairaw
authored andcommitted
Document 2 APIs in System.Security.Cryptography.DCACng (#2968)
* Document 2 APIs in System.Security.Cryptography.DSACng * suggestions Co-Authored-By: Eric StJohn <[email protected]> Co-Authored-By: Ron Petrusha <[email protected]> * suggestion by mairaw Co-Authored-By: Maira Wenzel <[email protected]>
1 parent c366ec9 commit 77ac92a

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

xml/System.Security.Cryptography/DSACng.xml

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -171,10 +171,8 @@
171171
<summary>Creates the digital signature for the specified data.</summary>
172172
<returns>The digital signature for the specified data.</returns>
173173
<remarks>To be added.</remarks>
174-
<exception cref="T:System.ArgumentNullException">
175-
<paramref name="rgbHash" /> is <see langword="null" />.</exception>
176-
<exception cref="T:System.PlatformNotSupportedException">
177-
<paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key .</exception>
174+
<exception cref="T:System.ArgumentNullException"><paramref name="rgbHash" /> is <see langword="null" />.</exception>
175+
<exception cref="T:System.PlatformNotSupportedException"><paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key .</exception>
178176
</Docs>
179177
</Member>
180178
<Member MemberName="Dispose">
@@ -485,11 +483,11 @@
485483
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="netcore-3.0" />
486484
</Parameters>
487485
<Docs>
488-
<param name="hash">To be added.</param>
489-
<param name="destination">To be added.</param>
490-
<param name="bytesWritten">To be added.</param>
491-
<summary>To be added.</summary>
492-
<returns>To be added.</returns>
486+
<param name="hash">A read-only span of bytes containing a hash of the data to be signed.</param>
487+
<param name="destination">The buffer where the digital signature is to be written.</param>
488+
<param name="bytesWritten">When this method returns, the number of bytes that were written in <paramref name="destination" />.</param>
489+
<summary>Tries to create the digital signature for the specified data.</summary>
490+
<returns><see langword="true" /> if the digital signature was created successfully; <see langword="false" /> if the <paramref name="destination" /> buffer was too small.</returns>
493491
<remarks>To be added.</remarks>
494492
</Docs>
495493
</Member>
@@ -561,16 +559,14 @@
561559
<param name="rgbHash">The signed data.</param>
562560
<param name="rgbSignature">The digital signature to be verified.</param>
563561
<summary>Verifies if the specified digital signature matches the specified data.</summary>
564-
<returns>
565-
<see langword="true" /> if <paramref name="rgbSignature" /> matches the signature computed using the specified data; otherwise, <see langword="false" />.</returns>
562+
<returns><see langword="true" /> if <paramref name="rgbSignature" /> matches the signature computed using the specified data; otherwise, <see langword="false" />.</returns>
566563
<remarks>To be added.</remarks>
567564
<exception cref="T:System.ArgumentNullException">The <paramref name="rgbHash" /> parameter is <see langword="null" />.
568565

569566
-or-
570567

571568
The <paramref name="rgbSignature" /> parameter is <see langword="null" />.</exception>
572-
<exception cref="T:System.PlatformNotSupportedException">
573-
<paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key .</exception>
569+
<exception cref="T:System.PlatformNotSupportedException"><paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key.</exception>
574570
</Docs>
575571
</Member>
576572
<Member MemberName="VerifySignature">
@@ -596,12 +592,13 @@
596592
<Parameter Name="signature" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="netcore-3.0" />
597593
</Parameters>
598594
<Docs>
599-
<param name="hash">To be added.</param>
600-
<param name="signature">To be added.</param>
601-
<summary>To be added.</summary>
602-
<returns>To be added.</returns>
595+
<param name="hash">A read-only span of bytes containing the signed data.</param>
596+
<param name="signature">A read-only span of bytes containing the signature to be verified.</param>
597+
<summary>Verifies if the specified digital signature matches the specified data.</summary>
598+
<returns><see langword="true" /> if <paramref name="signature" /> matches the signature computed using the specified data; otherwise, <see langword="false" />.</returns>
603599
<remarks>To be added.</remarks>
600+
<exception cref="T:System.PlatformNotSupportedException"><paramref name="hash" /> is shorter in length than the Q value of the DSA key.</exception>
604601
</Docs>
605602
</Member>
606603
</Members>
607-
</Type>
604+
</Type>

0 commit comments

Comments
 (0)