Skip to content

Port System.Security.Cryptography.Xml triple slash to docs #7096

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

Merged
merged 4 commits into from
Sep 8, 2021
Merged

Port System.Security.Cryptography.Xml triple slash to docs #7096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fac0eae
Port System.Security.Cryptography.Xml triple slash to docs
carlossanlop Sep 3, 2021
c421233
Apply suggestions from code review
carlossanlop Sep 8, 2021
bf8c1dd
Update xml/System.Security.Cryptography.Xml/CryptoSignedXmlRecursionE…
carlossanlop Sep 8, 2021
6ecd4bd
Apply suggestions from code review
carlossanlop Sep 8, 2021
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
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/CipherReference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ EncryptedXml exml = new EncryptedXml(doc, ev);
<Docs>
<param name="uri">A Uniform Resource Identifier (URI) pointing to the encrypted data.</param>
<param name="transformChain">A <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object that describes transforms to do on the encrypted data.</param>
<param name="tc">To be added.</param>
<param name="tc">A <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object that describes transforms to do on the encrypted data.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Xml.CipherReference" /> class using the specified Uniform Resource Identifier (URI) and transform chain information.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Security.Cryptography.Xml/CryptoSignedXmlRecursionException.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>The exception that's thrown when the signed XML recursion limit is reached.
Catch this exception when computing the hash, in addition to the other exceptions that ComputeHash can throw.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/DataReference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<Docs>
<param name="uri">A Uniform Resource Identifier (URI) that points to the encrypted data.</param>
<param name="transformChain">A <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object that describes transforms to do on the encrypted data.</param>
<param name="tc">To be added.</param>
<param name="tc">A <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object that describes transforms to do on the encrypted data.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Xml.DataReference" /> class using the specified Uniform Resource Identifier (URI) and a <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/EncryptedReference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
<Docs>
<param name="uri">The Uniform Resource Identifier (URI) that points to the data to encrypt.</param>
<param name="transformChain">A <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object that describes transforms to be done on the data to encrypt.</param>
<param name="tc">To be added.</param>
<param name="tc">A <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object that describes transforms to be done on the data to encrypt.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Xml.EncryptedReference" /> class using the specified Uniform Resource Identifier (URI) and transform chain.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
20 changes: 10 additions & 10 deletions xml/System.Security.Cryptography.Xml/EncryptedXml.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@
<Docs>
<param name="encryptedData">The data to decrypt.</param>
<param name="symmetricAlgorithm">The symmetric key used to decrypt <paramref name="encryptedData" />.</param>
<param name="symAlg">To be added.</param>
<param name="symAlg">The symmetric key used to decrypt <paramref name="encryptedData" />.</param>
<summary>Decrypts an <see langword="&lt;EncryptedData&gt;" /> element using the specified symmetric algorithm.</summary>
<returns>A byte array that contains the raw decrypted plain text.</returns>
<remarks>
Expand Down Expand Up @@ -599,7 +599,7 @@
<Docs>
<param name="keyData">An array of bytes that represents an encrypted <see langword="&lt;EncryptedKey&gt;" /> element.</param>
<param name="symmetricAlgorithm">The symmetric key used to decrypt <paramref name="keyData" />.</param>
<param name="symAlg">To be added.</param>
<param name="symAlg">The symmetric key used to decrypt <paramref name="keyData" />.</param>
<summary>Decrypts an <see langword="&lt;EncryptedKey&gt;" /> element using a symmetric algorithm.</summary>
<returns>A byte array that contains the plain text key.</returns>
<remarks>
Expand Down Expand Up @@ -657,7 +657,7 @@
<param name="keyData">An array of bytes that represents an encrypted <see langword="&lt;EncryptedKey&gt;" /> element.</param>
<param name="rsa">The asymmetric key used to decrypt <paramref name="keyData" />.</param>
<param name="useOAEP">A value that specifies whether to use Optimal Asymmetric Encryption Padding (OAEP).</param>
<param name="fOAEP">To be added.</param>
<param name="fOAEP">A value that specifies whether to use Optimal Asymmetric Encryption Padding (OAEP).</param>
<summary>Decrypts an <see langword="&lt;EncryptedKey&gt;" /> element using an asymmetric algorithm.</summary>
<returns>A byte array that contains the plain text key.</returns>
<remarks>
Expand Down Expand Up @@ -972,9 +972,9 @@
</Parameters>
<Docs>
<param name="plaintext">The data to encrypt.</param>
<param name="plainText">To be added.</param>
<param name="plainText">The data to encrypt.</param>
<param name="symmetricAlgorithm">The symmetric algorithm to use for encryption.</param>
<param name="symAlg">To be added.</param>
<param name="symAlg">The symmetric algorithm to use for encryption.</param>
<summary>Encrypts data in the specified byte array using the specified symmetric algorithm.</summary>
<returns>A byte array of encrypted data.</returns>
<remarks>
Expand Down Expand Up @@ -1052,7 +1052,7 @@
<Docs>
<param name="inputElement">The element or its contents to encrypt.</param>
<param name="symmetricAlgorithm">The symmetric algorithm to use for encryption.</param>
<param name="symAlg">To be added.</param>
<param name="symAlg">The symmetric algorithm to use for encryption.</param>
<param name="content">
<see langword="true" /> to encrypt only the contents of the element; <see langword="false" /> to encrypt the entire element.</param>
<summary>Encrypts the specified element or its contents using the specified symmetric algorithm.</summary>
Expand Down Expand Up @@ -1144,7 +1144,7 @@
<Docs>
<param name="keyData">The key to encrypt.</param>
<param name="symmetricAlgorithm">The symmetric key used to encrypt <paramref name="keyData" />.</param>
<param name="symAlg">To be added.</param>
<param name="symAlg">The symmetric key used to encrypt <paramref name="keyData" />.</param>
<summary>Encrypts a key using a symmetric algorithm that a recipient uses to decrypt an <see langword="&lt;EncryptedData&gt;" /> element.</summary>
<returns>A byte array that represents the encrypted value of the <paramref name="keyData" /> parameter.</returns>
<remarks>
Expand Down Expand Up @@ -1204,7 +1204,7 @@
<param name="keyData">The key to encrypt.</param>
<param name="rsa">The asymmetric key used to encrypt <paramref name="keyData" />.</param>
<param name="useOAEP">A value that specifies whether to use Optimal Asymmetric Encryption Padding (OAEP).</param>
<param name="fOAEP">To be added.</param>
<param name="fOAEP">A value that specifies whether to use Optimal Asymmetric Encryption Padding (OAEP).</param>
<summary>Encrypts the key that a recipient uses to decrypt an <see langword="&lt;EncryptedData&gt;" /> element.</summary>
<returns>A byte array that represents the encrypted value of the <paramref name="keyData" /> parameter.</returns>
<remarks>
Expand Down Expand Up @@ -1270,7 +1270,7 @@
<Docs>
<param name="encryptedData">The <see cref="T:System.Security.Cryptography.Xml.EncryptedData" /> object that contains the initialization vector (IV) to retrieve.</param>
<param name="symmetricAlgorithmUri">The Uniform Resource Identifier (URI) that describes the cryptographic algorithm associated with the <paramref name="encryptedData" /> value.</param>
<param name="symAlgUri">To be added.</param>
<param name="symAlgUri">The Uniform Resource Identifier (URI) that describes the cryptographic algorithm associated with the <paramref name="encryptedData" /> value.</param>
<summary>Retrieves the decryption initialization vector (IV) from an <see cref="T:System.Security.Cryptography.Xml.EncryptedData" /> object.</summary>
<returns>A byte array that contains the decryption initialization vector (IV).</returns>
<remarks>
Expand Down Expand Up @@ -1328,7 +1328,7 @@
<Docs>
<param name="encryptedData">The <see cref="T:System.Security.Cryptography.Xml.EncryptedData" /> object that contains the decryption key to retrieve.</param>
<param name="symmetricAlgorithmUri">The size of the decryption key to retrieve.</param>
<param name="symAlgUri">To be added.</param>
<param name="symAlgUri">The size of the decryption key to retrieve.</param>
<summary>Retrieves the decryption key from the specified <see cref="T:System.Security.Cryptography.Xml.EncryptedData" /> object.</summary>
<returns>A <see cref="T:System.Security.Cryptography.SymmetricAlgorithm" /> object associated with the decryption key.</returns>
<remarks>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/EncryptionMethod.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
</Parameters>
<Docs>
<param name="algorithm">The Uniform Resource Identifier (URI) that describes the algorithm represented by an instance of the <see cref="T:System.Security.Cryptography.Xml.EncryptionMethod" /> class.</param>
<param name="strAlgorithm">To be added.</param>
<param name="strAlgorithm">The Uniform Resource Identifier (URI) that describes the algorithm represented by an instance of the <see cref="T:System.Security.Cryptography.Xml.EncryptionMethod" /> class.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Xml.EncryptionMethod" /> class specifying an algorithm Uniform Resource Identifier (URI).</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/EncryptionProperty.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
</Parameters>
<Docs>
<param name="elementProperty">An <see cref="T:System.Xml.XmlElement" /> object to use for initialization.</param>
<param name="elemProp">To be added.</param>
<param name="elemProp">An <see cref="T:System.Xml.XmlElement" /> object to use for initialization.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Xml.EncryptionProperty" /> class using an <see cref="T:System.Xml.XmlElement" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/KeyInfoEncryptedKey.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
</Parameters>
<Docs>
<param name="encryptedKey">An <see cref="T:System.Security.Cryptography.Xml.EncryptedKey" /> object that encapsulates an encrypted key.</param>
<param name="ek">To be added.</param>
<param name="ek">An <see cref="T:System.Security.Cryptography.Xml.EncryptedKey" /> object that encapsulates an encrypted key.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Xml.KeyInfoEncryptedKey" /> class using an <see cref="T:System.Security.Cryptography.Xml.EncryptedKey" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/KeyInfoRetrievalMethod.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@
<Docs>
<param name="strUri">The Uniform Resource Identifier (URI) of the information to be referenced by the new instance of <see cref="T:System.Security.Cryptography.Xml.KeyInfoRetrievalMethod" />.</param>
<param name="typeName">The URI that describes the type of data to retrieve.</param>
<param name="strType">To be added.</param>
<param name="strType">The URI that describes the type of data to retrieve.</param>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bartonjs @GrabYourPitchforks this was detected by DocsPortingTool as an argument that got renamed, and had to manually choose which was the old argument name. I am not entirely sure if strType was typeName or strUri, but it made more sense to me to choose the description from typeName. Was this the right choice?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's called typeName in both .NET Framework and .NET (nee Core), for some reason it was strType in Xamarin.

<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Xml.KeyInfoRetrievalMethod" /> class with the specified Uniform Resource Identifier (URI) pointing to the referenced <see cref="T:System.Security.Cryptography.Xml.KeyInfo" /> object and the URI that describes the type of data to retrieve.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/KeyReference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@
<Docs>
<param name="uri">A Uniform Resource Identifier (URI) that points to the encrypted key.</param>
<param name="transformChain">A <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object that describes transforms to do on the encrypted key.</param>
<param name="tc">To be added.</param>
<param name="tc">A <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object that describes transforms to do on the encrypted key.</param>
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Xml.KeyReference" /> class for XML encryption using the specified Uniform Resource Identifier (URI) and a <see cref="T:System.Security.Cryptography.Xml.TransformChain" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down