Skip to content

Commit

Permalink
Port System.Security documentation (#9191)
Browse files Browse the repository at this point in the history
* Port System.Security documentation

* Add missing APIs (their docs were found in the obj folder)

* seealso -> see
  • Loading branch information
carlossanlop authored Aug 18, 2023
1 parent 574d2cc commit 77b61cd
Show file tree
Hide file tree
Showing 28 changed files with 32,115 additions and 31,399 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,311 changes: 660 additions & 651 deletions xml/System.Security.Cryptography/AesGcm.xml

Large diffs are not rendered by default.

4,921 changes: 2,469 additions & 2,452 deletions xml/System.Security.Cryptography/AsymmetricAlgorithm.xml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,93 +1,93 @@
<Type Name="AuthenticationTagMismatchException" FullName="System.Security.Cryptography.AuthenticationTagMismatchException">
<TypeSignature Language="C#" Value="public sealed class AuthenticationTagMismatchException : System.Security.Cryptography.CryptographicException" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AuthenticationTagMismatchException extends System.Security.Cryptography.CryptographicException" />
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.AuthenticationTagMismatchException" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class AuthenticationTagMismatchException&#xA;Inherits CryptographicException" />
<TypeSignature Language="F#" Value="type AuthenticationTagMismatchException = class&#xA; inherit CryptographicException" />
<TypeSignature Language="C++ CLI" Value="public ref class AuthenticationTagMismatchException sealed : System::Security::Cryptography::CryptographicException" />
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Security.Cryptography.CryptographicException</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.NullableContext(2)&gt;]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationTagMismatchException ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.AuthenticationTagMismatchException.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; AuthenticationTagMismatchException();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationTagMismatchException (string? message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.AuthenticationTagMismatchException.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (message As String)" />
<MemberSignature Language="F#" Value="new System.Security.Cryptography.AuthenticationTagMismatchException : string -&gt; System.Security.Cryptography.AuthenticationTagMismatchException" Usage="new System.Security.Cryptography.AuthenticationTagMismatchException message" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; AuthenticationTagMismatchException(System::String ^ message);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationTagMismatchException (string? message, Exception? inner);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, class System.Exception inner) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.AuthenticationTagMismatchException.#ctor(System.String,System.Exception)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (message As String, inner As Exception)" />
<MemberSignature Language="F#" Value="new System.Security.Cryptography.AuthenticationTagMismatchException : string * Exception -&gt; System.Security.Cryptography.AuthenticationTagMismatchException" Usage="new System.Security.Cryptography.AuthenticationTagMismatchException (message, inner)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; AuthenticationTagMismatchException(System::String ^ message, Exception ^ inner);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="message" Type="System.String" />
<Parameter Name="inner" Type="System.Exception" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<param name="inner">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
<Type Name="AuthenticationTagMismatchException" FullName="System.Security.Cryptography.AuthenticationTagMismatchException">
<TypeSignature Language="C#" Value="public sealed class AuthenticationTagMismatchException : System.Security.Cryptography.CryptographicException" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AuthenticationTagMismatchException extends System.Security.Cryptography.CryptographicException" />
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.AuthenticationTagMismatchException" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class AuthenticationTagMismatchException&#xA;Inherits CryptographicException" />
<TypeSignature Language="F#" Value="type AuthenticationTagMismatchException = class&#xA; inherit CryptographicException" />
<TypeSignature Language="C++ CLI" Value="public ref class AuthenticationTagMismatchException sealed : System::Security::Cryptography::CryptographicException" />
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Security.Cryptography.CryptographicException</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.NullableContext(2)&gt;]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>The exception that is thrown when a decryption operation with an authenticated cipher has an authentication tag mismatch.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationTagMismatchException ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.AuthenticationTagMismatchException.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; AuthenticationTagMismatchException();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.AuthenticationTagMismatchException" /> class with default properties.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationTagMismatchException (string? message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.AuthenticationTagMismatchException.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (message As String)" />
<MemberSignature Language="F#" Value="new System.Security.Cryptography.AuthenticationTagMismatchException : string -&gt; System.Security.Cryptography.AuthenticationTagMismatchException" Usage="new System.Security.Cryptography.AuthenticationTagMismatchException message" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; AuthenticationTagMismatchException(System::String ^ message);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">The error message that explains the reason for the exception.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.AuthenticationTagMismatchException" /> class with a specified error message.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationTagMismatchException (string? message, Exception? inner);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, class System.Exception inner) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Security.Cryptography.AuthenticationTagMismatchException.#ctor(System.String,System.Exception)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (message As String, inner As Exception)" />
<MemberSignature Language="F#" Value="new System.Security.Cryptography.AuthenticationTagMismatchException : string * Exception -&gt; System.Security.Cryptography.AuthenticationTagMismatchException" Usage="new System.Security.Cryptography.AuthenticationTagMismatchException (message, inner)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; AuthenticationTagMismatchException(System::String ^ message, Exception ^ inner);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Security.Cryptography</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="message" Type="System.String" />
<Parameter Name="inner" Type="System.Exception" />
</Parameters>
<Docs>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="inner">The exception that is the cause of the current exception. If the parameter is not <see langword="null" />, the current exception is raised in a catch block that handles the inner exception.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.AuthenticationTagMismatchException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
Loading

0 comments on commit 77b61cd

Please sign in to comment.