Skip to content

Commit 09563c4

Browse files
committed
System.Security.Cryptography docs
1 parent be3aa11 commit 09563c4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1869
-425
lines changed

xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@
298298
<returns>
299299
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
300300
<remarks>To be added.</remarks>
301-
<inheritdoc cref="M:System.Collections.Generic.ICollection`1.Contains(`0)" />
301+
<inheritdoc />
302302
</Docs>
303303
</Member>
304304
<Member MemberName="ContainsKey">
@@ -329,7 +329,7 @@
329329
<returns>
330330
<see langword="true" /> if the <see cref="T:System.Collections.Generic.IDictionary`2" /> contains an element with the key; otherwise, <see langword="false" />.</returns>
331331
<remarks>To be added.</remarks>
332-
<inheritdoc cref="M:System.Collections.Generic.IDictionary`2.ContainsKey(`0)" />
332+
<inheritdoc />
333333
</Docs>
334334
</Member>
335335
<Member MemberName="CopyTo">
@@ -366,7 +366,7 @@
366366
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
367367
<summary>Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
368368
<remarks>To be added.</remarks>
369-
<inheritdoc cref="M:System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32)" />
369+
<inheritdoc />
370370
</Docs>
371371
</Member>
372372
<Member MemberName="Count">
@@ -805,7 +805,7 @@ This member is an explicit interface member implementation. It can be used only
805805
<returns>
806806
<see langword="true" /> if the object that implements <see cref="T:System.Collections.Generic.IDictionary`2" /> contains an element with the specified key; otherwise, <see langword="false" />.</returns>
807807
<remarks>To be added.</remarks>
808-
<inheritdoc cref="M:System.Collections.Generic.IDictionary`2.TryGetValue(`0,`1@)" />
808+
<inheritdoc />
809809
</Docs>
810810
</Member>
811811
<Member MemberName="Values">

xml/System.Security.Cryptography.Cose/CoseHeaderValue.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@
142142
<remarks>To be added.</remarks>
143143
<exception cref="T:System.ArgumentNullException">
144144
<paramref name="value" /> is <see langword="null" />.</exception>
145+
<seealso cref="M:System.Security.Cryptography.Cose.CoseHeaderValue.FromEncodedValue(System.Byte[])" />
145146
</Docs>
146147
</Member>
147148
<Member MemberName="FromBytes">
@@ -167,6 +168,7 @@
167168
<summary>Creates a <see cref="T:System.Security.Cryptography.Cose.CoseHeaderValue" /> instance from a span of bytes.</summary>
168169
<returns>An instance that represents the CBOR-encoded <paramref name="value" />.</returns>
169170
<remarks>To be added.</remarks>
171+
<seealso cref="M:System.Security.Cryptography.Cose.CoseHeaderValue.FromEncodedValue(System.ReadOnlySpan{System.Byte})" />
170172
</Docs>
171173
</Member>
172174
<Member MemberName="FromEncodedValue">

xml/System.Security.Cryptography.Cose/CoseMessage.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,7 @@
218218
<exception cref="T:System.ArgumentException">
219219
<paramref name="destination" /> is too small to hold the value.</exception>
220220
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Cose.CoseMessage.ProtectedHeaders" /> and <see cref="P:System.Security.Cryptography.Cose.CoseMessage.UnprotectedHeaders" /> collections have one or more labels in common.</exception>
221+
<seealso cref="M:System.Security.Cryptography.Cose.CoseMessage.GetEncodedLength" />
221222
</Docs>
222223
</Member>
223224
<Member MemberName="GetEncodedLength">
@@ -317,6 +318,7 @@
317318
<see langword="true" /> if <paramref name="destination" /> had sufficient length to receive the value; otherwise, <see langword="false" />.</returns>
318319
<remarks>Use <see cref="M:System.Security.Cryptography.Cose.CoseMessage.GetEncodedLength" /> to determine how many bytes result in encoding this message.</remarks>
319320
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Cose.CoseMessage.ProtectedHeaders" /> and <see cref="P:System.Security.Cryptography.Cose.CoseMessage.UnprotectedHeaders" /> collections have one or more labels in common.</exception>
321+
<seealso cref="M:System.Security.Cryptography.Cose.CoseMessage.GetEncodedLength" />
320322
</Docs>
321323
</Member>
322324
<Member MemberName="UnprotectedHeaders">

xml/System.Security.Cryptography.Cose/CoseMultiSignMessage.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,7 @@ One or more of the labels specified in a <see cref="P:System.Security.Cryptograp
358358

359359
<paramref name="index" /> is equal to or greater than the number of elements in <see cref="P:System.Security.Cryptography.Cose.CoseMultiSignMessage.Signatures" />.
360360
</exception>
361+
<seealso cref="P:System.Security.Cryptography.Cose.CoseMultiSignMessage.Signatures" />
361362
</Docs>
362363
</Member>
363364
<Member MemberName="RemoveSignature">
@@ -384,6 +385,7 @@ One or more of the labels specified in a <see cref="P:System.Security.Cryptograp
384385
<remarks>To be added.</remarks>
385386
<exception cref="T:System.ArgumentNullException">
386387
<paramref name="signature" /> is <see langword="null" />.</exception>
388+
<seealso cref="P:System.Security.Cryptography.Cose.CoseMultiSignMessage.Signatures" />
387389
</Docs>
388390
</Member>
389391
<Member MemberName="Signatures">
@@ -542,6 +544,7 @@ The <see cref="P:System.Security.Cryptography.Cose.CoseSigner.ProtectedHeaders"
542544

543545
One or more of the labels specified in a <see cref="P:System.Security.Cryptography.Cose.CoseHeaderLabel.CriticalHeaders" /> header is missing.
544546
</exception>
547+
<seealso cref="M:System.Security.Cryptography.Cose.CoseMultiSignMessage.SignDetachedAsync(System.IO.Stream,System.Security.Cryptography.Cose.CoseSigner,System.Security.Cryptography.Cose.CoseHeaderMap,System.Security.Cryptography.Cose.CoseHeaderMap,System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" />
545548
</Docs>
546549
</Member>
547550
<Member MemberName="SignDetached">
@@ -864,6 +867,7 @@ One or more of the labels specified in a <see cref="P:System.Security.Cryptograp
864867

865868
The message does not contain at least one signature.
866869
</exception>
870+
<seealso cref="M:System.Security.Cryptography.Cose.CoseMultiSignMessage.GetEncodedLength" />
867871
</Docs>
868872
</Member>
869873
<Member MemberName="TrySignDetached">

0 commit comments

Comments
 (0)