8000 Add missing documentation for DSA types (#3498) · CAndRyan/dotnet-api-docs@645dfb9 · GitHub
[go: up one dir, main page]
Skip to content

Commit 645dfb9

Browse files
bartonjsmairaw
bartonjs
authored and
mairaw
committed
Add missing documentation for DSA types (dotnet#3498)
* Add missing documentation for DSA types * Apply suggestions from code review Co-Authored-By: Maira Wenzel <mairaw@microsoft.com> Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> * change to altmember * small edits * Fix malformed altmember docids * Fix OpenSslVersion and Create xrefs * fix broken link
1 parent 0acf7c4 commit 645dfb9

File tree

4 files changed

+220
-88
lines changed
< 10000 /span>

4 files changed

+220
-88
lines changed

‎xml/System.Security.Cryptography/DSA.xml

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,9 +287,9 @@
287287
<Parameter Name="rgbHash" Type="System.Byte[]" />
288288
</Parameters>
289289
<Docs>
290-
<param name="rgbHash">The data to be signed.</param>
291-
<summary>When overridden in a derived class, creates the <see cref="T:System.Security.Cryptography.DSA" /> signature for the specified data.</summary>
292-
<returns>The digital signature for the specified data.</returns>
290+
<param name="rgbHash">The hash value to be signed.</param>
291+
<summary>When overridden in a derived class, creates the <see cref="T:System.Security.Cryptography.DSA" /> signature for the specified hash value.</summary>
292+
<returns>The digital signature for the specified hash value.</returns>
293293
<remarks>To be added.</remarks>
294294
<related type="Article" href="~/docs/standard/security/cryptographic-services.md">Cryptographic Services</related>
295295
</Docs>
@@ -624,6 +624,15 @@ The algorithm-specific key import failed.
624624
<param name="parameters">The parameters for <see cref="T:System.Security.Cryptography.DSA" />.</param>
625625
<summary>When overridden in a derived class, imports the specified <see cref="T:System.Security.Cryptography.DSAParameters" />.</summary>
626626
<remarks>To be added.</remarks>
627+
<exception cref="T:System.ArgumentException">
628+
<paramref name="parameters"/> is missing required fields.
629+
630+
-or-
631+
632+
<paramref name="parameters"/> has fields with inconsistent lengths for a valid key.
633+
</exception>
634+
<exception cref="T:System.Security.Cryptography.CryptographicException">
635+
<paramref name="parameters"/> does not represent a valid DSA key parameter set.</exception>
627636
<related type="Article" href="~/docs/standard/security/cryptographic-services.md">Cryptographic Services</related>
628637
</Docs>
629638
</Member>

‎xml/System.Security.Cryptography/DSACng.xml

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -167,14 +167,21 @@
167167
<Parameter Name="rgbHash" Type="System.Byte[]" />
168168
</Parameters>
169169
<Docs>
170-
<param name="rgbHash">The data to be signed.</param>
171-
<summary>Creates the digital signature for the specified data.</summary>
170+
<param name="rgbHash">The hash value to be signed.</param>
171+
<summary>Creates the <see cref="T:System.Security.Cryptography.DSA" /> signature for the specified data.</summary>
172172
<returns>The digital signature for the specified data.</returns>
173173
<remarks>To be added.</remarks>
174174
<exception cref="T:System.ArgumentNullException">
175175
<paramref name="rgbHash" /> is <see langword="null" />.</exception>
176+
<exception cref="T:System.Security.Cryptography.CryptographicException">
177+
This instance represents only a public key.
178+
179+
-or-
180+
181+
An error occurred during signature creation.
182+
</exception>
176183
<exception cref="T:System.PlatformNotSupportedException">
177-
<paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key .</exception>
184+
<paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key.</exception>
178185
</Docs>
179186
</Member>
180187
<Member MemberName="Dispose">
@@ -202,8 +209,8 @@
202209
<Parameter Name="disposing" Type="System.Boolean" />
203210
</Parameters>
204211
<Docs>
205-
<param name="disposing">To be added.</param>
206-
<summary>To be added.</summary>
212+
<param name="disposing"><see langword="true"/> to release managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
213+
<summary>Releases the resources used by the current instance of the <see xref="T:System.Security.Cryptography.DSACng" /> class.</summary>
207214
<remarks>To be added.</remarks>
208215
</Docs>
209< 57AE /code>216
</Member>
@@ -265,10 +272,10 @@
265272
<Parameter Name="hashAlgorithm" Type="System.Security.Cryptography.HashAlgorithmName" />
266273
</Parameters>
267274
<Docs>
268-
<param name="data">To be added.</param>
269-
<param name="hashAlgorithm">To be added.</param>
270-
<summary>To be added.</summary>
271-
<returns>To be added.</returns>
275+
<param name="data">The binary stream to hash.</param>
276+
<param name="hashAlgorithm">The algorithm to use to hash the data.</param>
277+
<summary>Computes the hash value of a specified binary stream by using a specified hashing algorithm.</summary>
278+
<returns>The hashed data.</returns>
272279
<remarks>To be added.</remarks>
273280
</Docs>
274281
</Member>
@@ -299,12 +306,12 @@
299306
<Parameter Name="hashAlgorithm" Type="System.Security.Cryptography.HashAlgorithmName" />
300307
</Parameters>
301308
<Docs>
302-
<param name="data">To be added.</param>
303-
<param name="offset">To be added.</param>
304-
<param name="count">To be added.</param>
305-
<param name="hashAlgorithm">To be added.</param>
306-
<summary>To be added.</summary>
307-
<returns>To be added.</returns>
309+
<param name="data">The data to be hashed.</param>
310+
<param name="offset">The index of the first byte in <paramref name="data" /> that is to be hashed.</param>
311+
<param name="count">The number of bytes to hash.</param>
312+
<param name="hashAlgorithm">The algorithm to use to hash the data.</param>
313+
<summary>When overridden in a derived class, computes the hash value of a specified portion of a byte array by using a specified hashing algorithm.</summary>
314+
<returns>The hashed data.</returns>
308315
<remarks>To be added.</remarks>
309316
</Docs>
310317
</Member>
@@ -492,19 +499,13 @@
492499
<Parameter Name="rgbSignature" Type="System.Byte[]" />
493500
</Parameters>
494501
<Docs>
495-
<param name="rgbHash">The signed data.</param>
502+
<param name="rgbHash">The signed hash.</param>
496503
<param name="rgbSignature">The digital signature to be verified.</param>
497-
<summary>Verifies if the specified digital signature matches the specified data.</summary>
504+
<summary>Verifies if the specified digital signature matches the specified hash.</summary>
498505
<returns>
499-
<see langword="true" /> if <paramref name="rgbSignature" /> matches the signature computed using the specified data; otherwise, <see langword="false" />.</returns>
506+
<see langword="true" /> if <paramref name="rgbSignature" /> matches the signature computed using the specified hash; otherwise, <see langword="false" />.</returns>
500507
<remarks>To be added.</remarks>
501-
<exception cref="T:System.ArgumentNullException">The <paramref name="rgbHash" /> parameter is <see langword="null" />.
502-
503-
-or-
504-
505-
The <paramref name="rgbSignature" /> parameter is <see langword="null" />.</exception>
506-
<exception cref="T:System.PlatformNotSupportedException">
507-
<paramref name="rgbHash" /> is shorter in length than the Q value of the DSA key.</exception>
508+
<exception cref="T:System.ArgumentNullException">The <paramref name="rgbHash" /> or <paramref name="rgbSignature" /> parameters are <see langword="null" />.</exception>
508509
</Docs>
509510
</Member>
510511
</Members>

‎xml/System.Security.Cryptography/DSACryptoServiceProvider.xml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -354,8 +354,8 @@
354354
<Parameter Name="disposing" Type="System.Boolean" />
355355
</Parameters>
356356
<Docs>
357-
<param name="disposing">To be added.</param>
358-
<summary>To be added.</summary>
357+
<param name="disposing"><see langword="true"/> to release managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
358+
<summary>Releases the resources used by the current instance of the <see xref="T:System.Security.Cryptography.DSACng" /> class.</summary>
359359
<remarks>To be added.</remarks>
360360
</Docs>
361361
</Member>
@@ -489,7 +489,7 @@
489489
</ReturnValue>
490490
<Parameters />
491491
<Docs>
492-
<summary>To be added.</summary>
492+
<summary>Frees all resources associated with this instance.</summary>
493493
<remarks>To be added.</remarks>
494494
</Docs>
495495
</Member>
@@ -522,10 +522,10 @@
522522
<Parameter Name="hashAlgorithm" Type="System.Security.Cryptography.HashAlgorithmName" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.1" />
523523
</Parameters>
524524
<Docs>
525-
<param name="data">To be added.</param>
526-
<param name="hashAlgorithm">To be added.</param>
527-
<summary>To be added.</summary>
528-
<returns>To be added.</returns>
525+
<param name="data">The binary stream to hash.</param>
526+
<param name="hashAlgorithm">The algorithm to use to hash the data.</param>
527+
<summary>Computes the hash value of a specified binary stream by using a specified hashing algorithm.</summary>
528+
<returns>The hashed data.</returns>
529529
<remarks>To be added.</remarks>
530530
</Docs>
531531
</Member>
@@ -560,12 +560,12 @@
560560
<Parameter Name="hashAlgorithm" Type="System.Security.Cryptography.HashAlgorithmName" Index="3" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.1" />
561561
</Parameters>
562562
<Docs>
563-
<param name="data">To be added.</param>
564-
<param name="offset">To be added.</param>
565-
<param name="count">To be added.</param>
566-
<param name="hashAlgorithm">To be added.</param>
567-
<summary>To be added.</summary>
568-
<returns>To be added.</returns>
563+
<param name="data">The data to be hashed.</param>
564+
<param name="offset">The index of the first byte in <paramref name="data" /> to be hashed.</param>
565+
<param name="count">The number of bytes to hash.</param>
566+
<param name="hashAlgorithm">The algorithm to use to hash the data.</param>
567+
<summary>When overridden in a derived class, computes the hash value of a specified portion of a byte array by using a specified hashing algorithm.</summary>
568+
<returns>The hashed data.</returns>
569569
<remarks>To be added.</remarks>
570570
</Docs>
571571
</Member>

0 commit comments

Comments
 (0)
0