Skip to content

Commit 345b01d

Browse files
bartonjsgewarren
bartonjs
and
gewarren
authored
Add missing System.Security.* documentation
 Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
1 parent bf598ba commit 345b01d

10 files changed

+58
-5
lines changed

‎xml/System.Security.Cryptography.X509Certificates/X500DistinguishedNameBuilder.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Because the builder creates the `SEQUENCE OF` in reverse, and <xref:System.Secur
4949
</AssemblyInfo>
5050
<Parameters />
5151
<Docs>
52-
<summary>To be added.</summary>
52+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.X509Certificates.X500DistinguishedNameBuilder" /> class.</summary>
5353
<remarks>To be added.</remarks>
5454
</Docs>
5555
</Member>

‎xml/System.Security.Cryptography.X509Certificates/X509ChainPolicy.xml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,9 +256,18 @@
256256
</ReturnValue>
257257
<Parameters />
258258
<Docs>
259-
<summary>To be added.</summary>
260-
<returns>To be added.</returns>
259+
<summary>Creates a new chain policy instance that has the same settings as this instance.</summary>
260+
<returns>A new chain policy instance that has the same settings as this instance.</returns>
261261
<remarks>To be added.</remarks>
262+
<remarks>
263+
<format type="text/markdown"><![CDATA[
264+
265+
## Remarks
266+
267+
The collection properties on the returned instance have the same contents but are different collections. Adding to, or removing from, these collections only affects one chain policy instance. Mutation operations applied to the contents of the collections, such as calling <xref:System.Security.Cryptography.X509Certificates.X509Certificate.Dispose> on an element in <xref:System.Security.Cryptography.X509Certificates.X509ChainPolicy.ExtraStore>, have an effect on both chain policy instances.
268+
269+
]]></format>
270+
</remarks>
262271
</Docs>
263272
</Member>
264273
<Member MemberName="CustomTrustStore">

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@ An error occurred during signature creation.
308308
<summary>To be added.</summary>
309309
<returns>To be added.</returns>
310310
<remarks>To be added.</remarks>
311+
<inheritdoc />
311312
</Docs>
312313
</Member>
313314
<Member MemberName="ExportEncryptedPkcs8PrivateKey">
@@ -338,6 +339,7 @@ An error occurred during signature creation.
338339
<summary>To be added.</summary>
339340
<returns>To be added.</returns>
340341
<remarks>To be added.</remarks>
342+
<inheritdoc />
341343
</Docs>
342344
</Member>
343345
<Member MemberName="ExportParameters">
@@ -493,6 +495,7 @@ An error occurred during signature creation.
493495
<param name="bytesRead">To be added.</param>
494496
<summary>To be added.</summary>
495497
<remarks>To be added.</remarks>
498+
<inheritdoc />
496499
</Docs>
497500
</Member>
498501
<Member MemberName="ImportEncryptedPkcs8PrivateKey">
@@ -524,6 +527,7 @@ An error occurred during signature creation.
524527
<param name="bytesRead">To be added.</param>
525528
<summary>To be added.</summary>
526529
<remarks>To be added.</remarks>
530+
<inheritdoc />
527531
</Docs>
528532
</Member>
529533
<Member MemberName="ImportParameters">
@@ -748,6 +752,7 @@ An error occurred during signature creation.
748752
<summary>To be added.</summary>
749753
<returns>To be added.</returns>
750754
<remarks>To be added.</remarks>
755+
<inheritdoc />
751756
</Docs>
752757
</Member>
753758
<Member MemberName="TryExportEncryptedPkcs8PrivateKey">
@@ -782,6 +787,7 @@ An error occurred during signature creation.
782787
<summary>To be added.</summary>
783788
<returns>To be added.</returns>
784789
<remarks>To be added.</remarks>
790+
<inheritdoc />
785791
</Docs>
786792
</Member>
787793
<Member MemberName="TryExportEncryptedPkcs8PrivateKey">
@@ -816,6 +822,7 @@ An error occurred during signature creation.
816822
<summary>To be added.</summary>
817823
<returns>To be added.</returns>
818824
<remarks>To be added.</remarks>
825+
<inheritdoc />
819826
</Docs>
820827
</Member>
821828
<Member MemberName="TryExportPkcs8PrivateKey">
@@ -846,6 +853,7 @@ An error occurred during signature creation.
846853
<summary>To be added.</summary>
847854
<returns>To be added.</returns>
848855
<remarks>To be added.</remarks>
856+
<inheritdoc />
849857
</Docs>
850858
</Member>
851859
<Member MemberName="VerifySignature">
@@ -926,6 +934,7 @@ An error occurred during signature creation.
926934
<summary>To be added.</summary>
927935
<returns>To be added.</returns>
928936
<remarks>To be added.</remarks>
937+
<inheritdoc />
929938
</Docs>
930939
</Member>
931940
</Members>

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -816,6 +816,7 @@
816816
<param name="bytesRead">To be added.</param>
817817
<summary>To be added.</summary>
818818
<remarks>To be added.</remarks>
819+
<inheritdoc />
819820
</Docs>
820821
</Member>
821822
<Member MemberName="ImportEncryptedPkcs8PrivateKey">
@@ -850,6 +851,7 @@
850851
<param name="bytesRead">To be added.</param>
851852
<summary>To be added.</summary>
852853
<remarks>To be added.</remarks>
854+
<inheritdoc />
853855
</Docs>
854856
</Member>
855857
<Member MemberName="ImportParameters">

‎xml/System.Security.Cryptography/ECAlgorithm.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.ECAlgorithm" /> class.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>

‎xml/System.Security.Cryptography/ECDiffieHellmanCng.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -785,6 +785,7 @@ This instance represents only a public key.</exception>
785785
<summary>To be added.</summary>
786786
<returns>To be added.</returns>
787787
<remarks>To be added.</remarks>
788+
<inheritdoc />
788789
</Docs>
789790
</Member>
790791
<Member MemberName="ExportEncryptedPkcs8PrivateKey">
@@ -815,6 +816,7 @@ This instance represents only a public key.</exception>
815816
<summary>To be added.</summary>
816817
<returns>To be added.</returns>
817818
<remarks>To be added.</remarks>
819+
<inheritdoc />
818820
</Docs>
819821
</Member>
820822
<Member MemberName="ExportExplicitParameters">
@@ -1192,6 +1194,7 @@ This instance represents only a public key.</exception>
11921194
<param name="bytesRead">To be added.</param>
11931195
<summary>To be added.</summary>
11941196
<remarks>To be added.</remarks>
1197+
<inheritdoc />
11951198
</Docs>
11961199
</Member>
11971200
<Member MemberName="ImportEncryptedPkcs8PrivateKey">
@@ -1223,6 +1226,7 @@ This instance represents only a public key.</exception>
12231226
<param name="bytesRead">To be added.</param>
12241227
<summary>To be added.</summary>
12251228
<remarks>To be added.</remarks>
1229+
<inheritdoc />
12261230
</Docs>
12271231
</Member>
12281232
<Member MemberName="ImportParameters">
@@ -1302,6 +1306,7 @@ This instance represents only a public key.</exception>
13021306
<param name="bytesRead">To be added.</param>
13031307
<summary>To be added.</summary>
13041308
<remarks>To be added.</remarks>
1309+
<inheritdoc />
13051310
</Docs>
13061311
</Member>
13071312
<Member MemberName="Key">
@@ -1506,6 +1511,7 @@ Because key sizes do not uniquely identify elliptic curves, the use of the prope
15061511
<summary>To be added.</summary>
15071512
<value>To be added.</value>
15081513
<remarks>To be added.</remarks>
1514+
<inheritdoc />
15091515
</Docs>
15101516
</Member>
15111517
<Member MemberName="PublicKey">
@@ -1844,6 +1850,7 @@ Because key sizes do not uniquely identify elliptic curves, the use of the prope
18441850
<summary>To be added.</summary>
18451851
<returns>To be added.</returns>
18461852
<remarks>To be added.</remarks>
1853+
<inheritdoc />
18471854
</Docs>
18481855
</Member>
18491856
<Member MemberName="TryExportEncryptedPkcs8PrivateKey">
@@ -1878,6 +1885,7 @@ Because key sizes do not uniquely identify elliptic curves, the use of the prope
18781885
<summary>To be added.</summary>
18791886
<returns>To be added.</returns>
18801887
<remarks>To be added.</remarks>
1888+
<inheritdoc />
18811889
</Docs>
18821890
</Member>
18831891
<Member MemberName="TryExportPkcs8PrivateKey">
@@ -1908,6 +1916,7 @@ Because key sizes do not uniquely identify elliptic curves, the use of the prope
19081916
<summary>To be added.</summary>
19091917
<returns>To be added.</returns>
19101918
<remarks>To be added.</remarks>
1919+
<inheritdoc />
19111920
</Docs>
19121921
</Member>
19131922
<Member MemberName="UseSecretAgreementAsHmacKey">

‎xml/System.Security.Cryptography/ECDsaCng.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.ECDsaCng.ImportPar
381381
<summary>To be added.</summary>
382382
<returns>To be added.</returns>
383383
<remarks>To be added.</remarks>
384+
<inheritdoc />
384385
</Docs>
385386
</Member>
386387
<Member MemberName="ExportEncryptedPkcs8PrivateKey">
@@ -411,6 +412,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.ECDsaCng.ImportPar
411412
<summary>To be added.</summary>
412413
<returns>To be added.</returns>
413414
<remarks>To be added.</remarks>
415+
<inheritdoc />
414416
</Docs>
415417
</Member>
416418
<Member MemberName="ExportExplicitParameters">
@@ -825,6 +827,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.ECDsaCng.ImportPar
825827
<param name="bytesRead">To be added.</param>
826828
<summary>To be added.</summary>
827829
<remarks>To be added.</remarks>
830+
<inheritdoc />
828831
</Docs>
829832
</Member>
830833
<Member MemberName="ImportEncryptedPkcs8PrivateKey">
@@ -856,6 +859,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.ECDsaCng.ImportPar
856859
<param name="bytesRead">To be added.</param>
857860
<summary>To be added.</summary>
858861
<remarks>To be added.</remarks>
862+
<inheritdoc />
859863
</Docs>
860864
</Member>
861865
<Member MemberName="ImportParameters">
@@ -940,6 +944,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.ECDsaCng.ImportPar
940944
<param name="bytesRead">To be added.</param>
941945
<summary>To be added.</summary>
942946
<remarks>To be added.</remarks>
947+
<inheritdoc />
943948
</Docs>
944949
</Member>
945950
<Member MemberName="Key">
@@ -1469,6 +1474,7 @@ but that is not reflected in this property.
14691474
<summary>To be added.</summary>
14701475
<returns>To be added.</returns>
14711476
<remarks>To be added.</remarks>
1477+
<inheritdoc />
14721478
</Docs>
14731479
</Member>
14741480
<Member MemberName="TryExportEncryptedPkcs8PrivateKey">
@@ -1503,6 +1509,7 @@ but that is not reflected in this property.
15031509
<summary>To be added.</summary>
15041510
<returns>To be added.</returns>
15051511
<remarks>To be added.</remarks>
1512+
<inheritdoc />
15061513
</Docs>
15071514
</Member>
15081515
<Member MemberName="TryExportPkcs8PrivateKey">
@@ -1533,6 +1540,7 @@ but that is not reflected in this property.
15331540
<summary>To be added.</summary>
15341541
<returns>To be added.</returns>
15351542
<remarks>To be added.</remarks>
1543+
<inheritdoc />
15361544
</Docs>
15371545
</Member>
15381546
<Member MemberName="TrySignHash">
@@ -1565,6 +1573,7 @@ but that is not reflected in this property.
15651573
<summary>To be added.</summary>
15661574
<returns>To be added.</returns>
15671575
<remarks>To be added.</remarks>
1576+
<inheritdoc />
15681577
</Docs>
15691578
</Member>
15701579
<Member MemberName="TrySignHashCore">
@@ -1599,6 +1608,7 @@ but that is not reflected in this property.
15991608
<summary>To be added.</summary>
16001609
<returns>To be added.</returns>
16011610
<remarks>To be added.</remarks>
1611+
<inheritdoc />
16021612
</Docs>
16031613
</Member>
16041614
<MemberGroup MemberName="VerifyData">
@@ -1884,6 +1894,7 @@ but that is not reflected in this property.
18841894
<summary>To be added.</summary>
18851895
<returns>To be added.</returns>
18861896
<remarks>To be added.</remarks>
1897+
<inheritdoc />
18871898
</Docs>
18881899
</Member>
18891900
<Member MemberName="VerifyHashCore">
@@ -1916,6 +1927,7 @@ but that is not reflected in this property.
19161927
<summary>To be added.</summary>
19171928
<returns>To be added.</returns>
19181929
<remarks>To be added.</remarks>
1930+
<inheritdoc />
19191931
</Docs>
19201932
</Member>
19211933
</Members>

‎xml/System.Security.Cryptography/RSACng.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.RSACng.ImportParam
492492
<summary>To be added.</summary>
493493
<returns>To be added.</returns>
494494
<remarks>To be added.</remarks>
495+
<inheritdoc />
495496
</Docs>
496497
</Member>
497498
<Member MemberName="ExportEncryptedPkcs8PrivateKey">
@@ -522,6 +523,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.RSACng.ImportParam
522523
<summary>To be added.</summary>
523524
<returns>To be added.</returns>
524525
<remarks>To be added.</remarks>
526+
<inheritdoc />
525527
</Docs>
526528
</Member>
527529
<Member MemberName="ExportParameters">
@@ -698,6 +700,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.RSACng.ImportParam
698700
<param name="bytesRead">To be added.</param>
699701
<summary>To be added.</summary>
700702
<remarks>To be added.</remarks>
703+
<inheritdoc />
701704
</Docs>
702705
</Member>
703706
<Member MemberName="ImportEncryptedPkcs8PrivateKey">
@@ -729,6 +732,7 @@ If a key is loaded via the <xref:System.Security.Cryptography.RSACng.ImportParam
729732
<param name="bytesRead">To be added.</param>
730733
<summary>To be added.</summary>
731734
<remarks>To be added.</remarks>
735+
<inheritdoc />
732736
</Docs>
733737
</Member>
734738
<Member MemberName="ImportParameters">
@@ -825,6 +829,7 @@ any already open key is unaffected by this method.
825829
<param name="bytesRead">To be added.</param>
826830
<summary>To be added.</summary>
827831
<remarks>To be added.</remarks>
832+
<inheritdoc />
828833
</Docs>
829834
</Member>
830835
<Member MemberName="Key">
@@ -1129,6 +1134,7 @@ any already open key is unaffected by this method.
11291134
<summary>To be added.</summary>
11301135
<returns>To be added.</returns>
11311136
<remarks>To be added.</remarks>
1137+
<inheritdoc />
11321138
</Docs>
11331139
</Member>
11341140
<Member MemberName="TryExportEncryptedPkcs8PrivateKey">
@@ -1163,6 +1169,7 @@ any already open key is unaffected by this method.
11631169
<summary>To be added.</summary>
11641170
<returns>To be added.</returns>
11651171
<remarks>To be added.</remarks>
1172+
<inheritdoc />
11661173
</Docs>
11671174
</Member>
11681175
<Member MemberName="TryExportPkcs8PrivateKey">
@@ -1193,6 +1200,7 @@ any already open key is unaffected by this method.
11931200
<summary>To be added.</summary>
11941201
<returns>To be added.</returns>
11951202
<remarks>To be added.</remarks>
1203+
<inheritdoc />
11961204
</Docs>
11971205
</Member>
11981206
<Member MemberName="TrySignHash">
@@ -1229,6 +1237,7 @@ any already open key is unaffected by this method.
12291237
<summary>To be added.</summary>
12301238
<returns>To be added.</returns>
12311239
<remarks>To be added.</remarks>
1240+
<inheritdoc />
12321241
</Docs>
12331242
</Member>
12341243
<Member MemberName="VerifyHash">
@@ -1336,6 +1345,7 @@ any already open key is unaffected by this method.
13361345
<summary>To be added.</summary>
13371346
<returns>To be added.</returns>
13381347
<remarks>To be added.</remarks>
1348+
<inheritdoc />
13391349
</Docs>
13401350
</Member>
13411351
</Members>

‎xml/System.Security.Cryptography/RSACryptoServiceProvider.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1336,6 +1336,7 @@ If no key is loaded via the <xref:System.Security.Cryptography.RSACryptoServiceP
13361336
<param name="bytesRead">To be added.</param>
13371337
<summary>To be added.</summary>
13381338
<remarks>To be added.</remarks>
1339+
<inheritdoc />
13391340
</Docs>
13401341
</Member>
13411342
<Member MemberName="ImportEncryptedPkcs8PrivateKey">
@@ -1370,6 +1371,7 @@ If no key is loaded via the <xref:System.Security.Cryptography.RSACryptoServiceP
13701371
<param name="bytesRead">To be added.</param>
13711372
<summary>To be added.</summary>
13721373
<remarks>To be added.</remarks>
1374+
<inheritdoc />
13731375
</Docs>
13741376
</Member>
13751377
<Member MemberName="ImportParameters">

‎xml/ns-System.Security.Cryptography.Cose.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="System.Security.Cryptography.Cose">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Contains types used in creating and processing CBOR Object Signing and Encryption (COSE) messages.</summary>
44
<remarks>To be added.</remarks>
55
</Docs>
66
</Namespace>

0 commit comments

Comments
 (0)