Skip to content

Add MemberGroup descriptions (System.Security) #12829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gewarren wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add MemberGroup descriptions (System.Security) #12829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions xml/System.Security.Authentication.ExtendedProtection/ChannelBinding.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@
<altmember cref="T:System.Net.TransportContext" />
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Security.Authentication.ExtendedProtection.ChannelBinding" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ChannelBinding ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Security.Claims/Claim.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1230,6 +1230,11 @@ if (null != principal)
<altmember cref="P:System.Security.Claims.Claim.Value" />
</Docs>
</Member>
<MemberGroup MemberName="WriteTo">
<Docs>
<summary>Writes this <see cref="T:System.Security.Claims.Claim" /> to the writer.</summary>
</Docs>
</MemberGroup>
<Member MemberName="WriteTo">
<MemberSignature Language="C#" Value="public virtual void WriteTo (System.IO.BinaryWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void WriteTo(class System.IO.BinaryWriter writer) cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Security.Claims/ClaimsIdentity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2421,6 +2421,11 @@ The comparison is done in <xref:System.StringComparison.OrdinalIgnoreCase?displa
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="WriteTo">
<Docs>
<summary>Serializes using a <see cref="T:System.IO.BinaryWriter" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName="WriteTo">
<MemberSignature Language="C#" Value="public virtual void WriteTo (System.IO.BinaryWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void WriteTo(class System.IO.BinaryWriter writer) cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Security.Claims/ClaimsPrincipal.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1489,6 +1489,11 @@ Each <xref:System.Security.Claims.ClaimsIdentity> is called.
<altmember cref="P:System.Security.Claims.ClaimsPrincipal.Identity" />
</Docs>
</Member>
<MemberGroup MemberName="WriteTo">
<Docs>
<summary>Serializes using a <see cref="T:System.IO.BinaryWriter" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName="WriteTo">
<MemberSignature Language="C#" Value="public virtual void WriteTo (System.IO.BinaryWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void WriteTo(class System.IO.BinaryWriter writer) cil managed" />
Expand Down
10 changes: 10 additions & 0 deletions xml/System.Security.Cryptography.Cose/CoseHeaderLabel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Cose.CoseHeaderLabel" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CoseHeaderLabel (int label);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 label) cil managed" />
Expand Down Expand Up @@ -152,6 +157,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Equals">
<Docs>
<summary>Returns a value indicating whether this instance is equal to a specified object.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object? obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
Expand Down
15 changes: 15 additions & 0 deletions xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Add">
<Docs>
<summary>Adds the specified label and value to the header map.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public void Add (System.Collections.Generic.KeyValuePair&lt;System.Security.Cryptography.Cose.CoseHeaderLabel,System.Security.Cryptography.Cose.CoseHeaderValue&gt; item);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Add(valuetype System.Collections.Generic.KeyValuePair`2&lt;valuetype System.Security.Cryptography.Cose.CoseHeaderLabel, valuetype System.Security.Cryptography.Cose.CoseHeaderValue&gt; item) cil managed" />
Expand Down Expand Up @@ -429,6 +434,11 @@
<inheritdoc />
</Docs>
</Member>
<MemberGroup MemberName="GetValueAsBytes">
<Docs>
<summary>Gets the value associated with the specified label, as a byte string.</summary>
</Docs>
</MemberGroup>
<Member MemberName="GetValueAsBytes">
<MemberSignature Language="C#" Value="public byte[] GetValueAsBytes (System.Security.Cryptography.Cose.CoseHeaderLabel label);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] GetValueAsBytes(valuetype System.Security.Cryptography.Cose.CoseHeaderLabel label) cil managed" />
Expand Down Expand Up @@ -626,6 +636,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Remove">
<Docs>
<summary>Removes the element with the specified key from the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public bool Remove (System.Collections.Generic.KeyValuePair&lt;System.Security.Cryptography.Cose.CoseHeaderLabel,System.Security.Cryptography.Cose.CoseHeaderValue&gt; item);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Remove(valuetype System.Collections.Generic.KeyValuePair`2&lt;valuetype System.Security.Cryptography.Cose.CoseHeaderLabel, valuetype System.Security.Cryptography.Cose.CoseHeaderValue&gt; item) cil managed" />
Expand Down
20 changes: 20 additions & 0 deletions xml/System.Security.Cryptography.Cose/CoseHeaderValue.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Equals">
<Docs>
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object? obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
Expand Down Expand Up @@ -120,6 +125,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="FromBytes">
<Docs>
<summary>Creates a <see cref="T:System.Security.Cryptography.Cose.CoseHeaderValue" /> instance from a byte array.</summary>
</Docs>
</MemberGroup>
<Member MemberName="FromBytes">
<MemberSignature Language="C#" Value="public static System.Security.Cryptography.Cose.CoseHeaderValue FromBytes (byte[] value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Security.Cryptography.Cose.CoseHeaderValue FromBytes(unsigned int8[] value) cil managed" />
Expand Down Expand Up @@ -174,6 +184,11 @@
<seealso cref="M:System.Security.Cryptography.Cose.CoseHeaderValue.FromEncodedValue(System.ReadOnlySpan{System.Byte})" />
</Docs>
</Member>
<MemberGroup MemberName="FromEncodedValue">
<Docs>
<summary>Creates a <see cref="T:System.Security.Cryptography.Cose.CoseHeaderValue" /> instance from a CBOR-encoded value.</summary>
</Docs>
</MemberGroup>
<Member MemberName="FromEncodedValue">
<MemberSignature Language="C#" Value="public static System.Security.Cryptography.Cose.CoseHeaderValue FromEncodedValue (byte[] encodedValue);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Security.Cryptography.Cose.CoseHeaderValue FromEncodedValue(unsigned int8[] encodedValue) cil managed" />
Expand Down Expand Up @@ -300,6 +315,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="GetValueAsBytes">
<Docs>
<summary>Gets the CBOR-encoded value as a byte string.</summary>
</Docs>
</MemberGroup>
<Member MemberName="GetValueAsBytes">
<MemberSignature Language="C#" Value="public byte[] GetValueAsBytes ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] GetValueAsBytes() cil managed" />
Expand Down
5 changes: 5 additions & 0 deletions xml/System.Security.Cryptography.Cose/CoseKey.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Cose.CoseKey" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CoseKey (System.Security.Cryptography.MLDsa key);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Security.Cryptography.MLDsa key) cil managed" />
Expand Down
15 changes: 15 additions & 0 deletions xml/System.Security.Cryptography.Cose/CoseMessage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="DecodeMultiSign">
<Docs>
<summary>Decodes a CBOR payload as a COSE_Sign message.</summary>
</Docs>
</MemberGroup>
<Member MemberName="DecodeMultiSign">
<MemberSignature Language="C#" Value="public static System.Security.Cryptography.Cose.CoseMultiSignMessage DecodeMultiSign (byte[] cborPayload);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Security.Cryptography.Cose.CoseMultiSignMessage DecodeMultiSign(unsigned int8[] cborPayload) cil managed" />
Expand Down Expand Up @@ -110,6 +115,11 @@
<paramref name="cborPayload" /> could not be decoded as a COSE_Sign message.</exception>
</Docs>
</Member>
<MemberGroup MemberName="DecodeSign1">
<Docs>
<summary>Decodes a CBOR payload as a COSE_Sign1 message.</summary>
</Docs>
</MemberGroup>
<Member MemberName="DecodeSign1">
<MemberSignature Language="C#" Value="public static System.Security.Cryptography.Cose.CoseSign1Message DecodeSign1 (byte[] cborPayload);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Security.Cryptography.Cose.CoseSign1Message DecodeSign1(unsigned int8[] cborPayload) cil managed" />
Expand Down Expand Up @@ -172,6 +182,11 @@
<paramref name="cborPayload" /> could not be decoded as a COSE_Sign1 message.</exception>
</Docs>
</Member>
<MemberGroup MemberName="Encode">
<Docs>
<summary>Encodes this message as CBOR.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Encode">
<MemberSignature Language="C#" Value="public byte[] Encode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] Encode() cil managed" />
Expand Down
25 changes: 25 additions & 0 deletions xml/System.Security.Cryptography.Cose/CoseMultiSignMessage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName="AddSignatureForDetached">
<Docs>
<summary>Adds a signature for the specified content to this message.</summary>
</Docs>
</MemberGroup>
<Member MemberName="AddSignatureForDetached">
<MemberSignature Language="C#" Value="public void AddSignatureForDetached (byte[] detachedContent, System.Security.Cryptography.Cose.CoseSigner signer, byte[]? associatedData = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddSignatureForDetached(unsigned int8[] detachedContent, class System.Security.Cryptography.Cose.CoseSigner signer, unsigned int8[] associatedData) cil managed" />
Expand Down Expand Up @@ -223,6 +228,11 @@ One or more of the labels specified in a <see cref="P:System.Security.Cryptograp
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
<MemberGroup MemberName="AddSignatureForEmbedded">
<Docs>
<summary>Adds a signature for the content embedded in this message.</summary>
</Docs>
</MemberGroup>
<Member MemberName="AddSignatureForEmbedded">
<MemberSignature Language="C#" Value="public void AddSignatureForEmbedded (System.Security.Cryptography.Cose.CoseSigner signer, byte[]? associatedData = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddSignatureForEmbedded(class System.Security.Cryptography.Cose.CoseSigner signer, unsigned int8[] associatedData) cil managed" />
Expand Down Expand Up @@ -332,6 +342,11 @@ One or more of the labels specified in a <see cref="P:System.Security.Cryptograp
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="RemoveSignature">
<Docs>
<summary>Removes the specified signature from the message.</summary>
</Docs>
</MemberGroup>
<Member MemberName="RemoveSignature">
<MemberSignature Language="C#" Value="public void RemoveSignature (int index);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveSignature(int32 index) cil managed" />
Expand Down Expand Up @@ -412,6 +427,11 @@ One or more of the labels specified in a <see cref="P:System.Security.Cryptograp
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="SignDetached">
<Docs>
<summary>Signs the specified content and encodes it as a COSE_Sign message with detached content.</summary>
</Docs>
</MemberGroup>
<Member MemberName="SignDetached">
<MemberSignature Language="C#" Value="public static byte[] SignDetached (byte[] detachedContent, System.Security.Cryptography.Cose.CoseSigner signer, System.Security.Cryptography.Cose.CoseHeaderMap? protectedHeaders = default, System.Security.Cryptography.Cose.CoseHeaderMap? unprotectedHeaders = default, byte[]? associatedData = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] SignDetached(unsigned int8[] detachedContent, class System.Security.Cryptography.Cose.CoseSigner signer, class System.Security.Cryptography.Cose.CoseHeaderMap protectedHeaders, class System.Security.Cryptography.Cose.CoseHeaderMap unprotectedHeaders, unsigned int8[] associatedData) cil managed" />
Expand Down Expand Up @@ -696,6 +716,11 @@ One or more of the labels specified in a <see cref="P:System.Security.Cryptograp
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
<MemberGroup MemberName="SignEmbedded">
<Docs>
<summary>Signs the specified content and encodes it as a COSE_Sign message with embedded content.</summary>
</Docs>
</MemberGroup>
<Member MemberName="SignEmbedded">
<MemberSignature Language="C#" Value="public static byte[] SignEmbedded (byte[] embeddedContent, System.Security.Cryptography.Cose.CoseSigner signer, System.Security.Cryptography.Cose.CoseHeaderMap? protectedHeaders = default, System.Security.Cryptography.Cose.CoseHeaderMap? unprotectedHeaders = default, byte[]? associatedData = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] SignEmbedded(unsigned int8[] embeddedContent, class System.Security.Cryptography.Cose.CoseSigner signer, class System.Security.Cryptography.Cose.CoseHeaderMap protectedHeaders, class System.Security.Cryptography.Cose.CoseHeaderMap unprotectedHeaders, unsigned int8[] associatedData) cil managed" />
Expand Down
Loading
Loading