Skip to content

fix tag formatting #2578

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 5 commits into from
Jun 11, 2019
Merged

fix tag formatting #2578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
072f6bd
fix tag formatting
mairaw Jun 10, 2019
c98a973
additional fix
mairaw Jun 10, 2019
349bb73
feedback + markdig
mairaw Jun 10, 2019
d460cb0
fix indentation
mairaw Jun 11, 2019
b6bcccc
change to clickable urls
mairaw Jun 11, 2019
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.IdentityModel.Tokens/EncryptedKeyIdentifierClause.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
When the <xref:System.IdentityModel.Tokens.EncryptedKeyIdentifierClause.CarriedKeyName%2A> property is serialized into XML, it is placed in the <`CarriedKeyName`> element. For encrypted keys, the <`CarriedKeyName`> element is an optional element that associates a user-readable name with a key value. This name can then be used to reference the key using the <`KeyName`> element within the <`KeyInfo`> element. The same <`CarriedKeyName`> element value, unlike an ID value, can occur multiple times within a single document. The value of the key must be the same in all <`EncryptedKey`> elements identified with the same <`CarriedKeyName`> name within an XML document.
When the <xref:System.IdentityModel.Tokens.EncryptedKeyIdentifierClause.CarriedKeyName%2A> property is serialized into XML, it is placed in the `<CarriedKeyName>` element. For encrypted keys, the `<CarriedKeyName>` element is an optional element that associates a user-readable name with a key value. This name can then be used to reference the key using the `<KeyName>` element within the `<KeyInfo>` element. The same `<CarriedKeyName>` element value, unlike an ID value, can occur multiple times within a single document. The value of the key must be the same in all `<EncryptedKey>` elements identified with the same `<CarriedKeyName>` name within an XML document.

]]></format>
</remarks>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/CipherData.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@


## Examples
The following code example uses the <xref:System.Security.Cryptography.Xml.EncryptedData> class to create an <`EncryptedData`> element that contains a <`CipherData`> element, and then writes the XML to an XML file.
The following code example uses the <xref:System.Security.Cryptography.Xml.EncryptedData> class to create an `<EncryptedData>` element that contains a `<CipherData>` element, and then writes the XML to an XML file.

[!code-cpp[cryptgraphy.Xml.EncryptedData#1](~/samples/snippets/cpp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/cpp/encrypteddata.cpp#1)]
[!code-csharp[cryptgraphy.Xml.EncryptedData#1](~/samples/snippets/csharp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/CS/encrypteddata.cs#1)]
Expand Down
4 changes: 2 additions & 2 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 @@ -398,7 +398,7 @@
## Remarks
Use the <xref:System.Security.Cryptography.Xml.EncryptedXml.DecryptData%2A> method to decrypt an <xref:System.Security.Cryptography.Xml.EncryptedData> element using a symmetric key.

Note that the <xref:System.Security.Cryptography.Xml.EncryptedXml.DecryptData%2A> method only decrypts top-level <`EncryptedData`> tags. In cases where one or more <`EncryptedData`> tags have been encrypted and are contained within higher level <`EncryptedData`> tags, you can call the <xref:System.Security.Cryptography.Xml.EncryptedXml.DecryptDocument%2A> method separately for each one. See the <xref:System.Security.Cryptography.Xml.EncryptedXml.DecryptDocument%2A> method for a code example.
Note that the <xref:System.Security.Cryptography.Xml.EncryptedXml.DecryptData%2A> method only decrypts top-level `<EncryptedData>` tags. In cases where one or more `<EncryptedData>` tags have been encrypted and are contained within higher level `<EncryptedData>` tags, you can call the <xref:System.Security.Cryptography.Xml.EncryptedXml.DecryptDocument%2A> method separately for each one. See the <xref:System.Security.Cryptography.Xml.EncryptedXml.DecryptDocument%2A> method for a code example.



Expand Down Expand Up @@ -471,7 +471,7 @@
[!code-csharp[Cryptography.XML.XMLEncMapKeyX509#1](~/samples/snippets/csharp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/CS/sample.cs#1)]
[!code-vb[Cryptography.XML.XMLEncMapKeyX509#1](~/samples/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb#1)]

The following code example demonstrates how to decrypt a high level <`EncryptedData`> tag that contains another encrypted <`EncryptedData`> tag.
The following code example demonstrates how to decrypt a high level `<EncryptedData>` tag that contains another encrypted `<EncryptedData>` tag.

[!code-csharp[Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption#1](~/samples/snippets/csharp/VS_Snippets_Misc/Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption/CS/sample.cs#1)]
[!code-vb[Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption#1](~/samples/snippets/visualbasic/VS_Snippets_Misc/Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption/VB/sample.vb#1)]
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography.Xml/KeyInfoX509Data.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,7 +546,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Security.Cryptography.Xml.KeyInfoX509Data.IssuerSerials%2A> property represents the `<X509IssuerSerial`> element of an XML digital signature using a list of <xref:System.Security.Cryptography.Xml.X509IssuerSerial> structures contained within. The `<X509IssuerSerial`> element represents an issuer name and serial number pair, which identify a specific X.509v3 certificate.
The <xref:System.Security.Cryptography.Xml.KeyInfoX509Data.IssuerSerials%2A> property represents the `<X509IssuerSerial>` element of an XML digital signature using a list of <xref:System.Security.Cryptography.Xml.X509IssuerSerial> structures contained within. The `<X509IssuerSerial>` element represents an issuer name and serial number pair, which identify a specific X.509v3 certificate.

The issuer of an X.509 certificate is the name of the certification authority that issued the certificate. Certification authorities assign each certificate they issue a unique serial number.

Expand Down
12 changes: 6 additions & 6 deletions xml/System.Security.Cryptography.Xml/Signature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Security.Cryptography.Xml.Signature> class represents the <`Signature`> element of an XML signature defined by the XML digital signature specification. The <`Signature`> element is the root element of an XML digital signature. The <xref:System.Security.Cryptography.Xml.Signature.SignedInfo%2A>, <xref:System.Security.Cryptography.Xml.Signature.SignatureValue%2A>, <xref:System.Security.Cryptography.Xml.Signature.KeyInfo%2A>, and <xref:System.Security.Cryptography.Xml.Signature.ObjectList%2A> properties encapsulate the subelements of the <`Signature`> element.
The <xref:System.Security.Cryptography.Xml.Signature> class represents the `<Signature>` element of an XML signature defined by the XML digital signature specification. The `<Signature>` element is the root element of an XML digital signature. The <xref:System.Security.Cryptography.Xml.Signature.SignedInfo%2A>, <xref:System.Security.Cryptography.Xml.Signature.SignatureValue%2A>, <xref:System.Security.Cryptography.Xml.Signature.KeyInfo%2A>, and <xref:System.Security.Cryptography.Xml.Signature.ObjectList%2A> properties encapsulate the subelements of the `<Signature>` element.

For more information about the <`Signature`> element, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).
For more information about the `<Signature>` element, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).



Expand Down Expand Up @@ -236,7 +236,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Security.Cryptography.Xml.Signature.KeyInfo%2A> property uses a <xref:System.Security.Cryptography.Xml.KeyInfo> object to represent the <`KeyInfo`> element of an XML digital signature.
The <xref:System.Security.Cryptography.Xml.Signature.KeyInfo%2A> property uses a <xref:System.Security.Cryptography.Xml.KeyInfo> object to represent the `<KeyInfo>` element of an XML digital signature.

For more information about XML digital signatures, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).

Expand Down Expand Up @@ -329,7 +329,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Security.Cryptography.Xml.Signature.ObjectList%2A> property uses a collection of <xref:System.Security.Cryptography.Xml.DataObject> objects to represent the <`Object`> tag of an XML digital signature.
The <xref:System.Security.Cryptography.Xml.Signature.ObjectList%2A> property uses a collection of <xref:System.Security.Cryptography.Xml.DataObject> objects to represent the `<Object>` tag of an XML digital signature.

You can also add a <xref:System.Security.Cryptography.Xml.DataObject> to this collection using the <xref:System.Security.Cryptography.Xml.Signature.AddObject%2A> method.

Expand Down Expand Up @@ -370,7 +370,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Security.Cryptography.Xml.Signature.SignatureValue%2A> property uses a byte array to represent the <`SignatureValue`> element of an XML digital signature contained within.
The <xref:System.Security.Cryptography.Xml.Signature.SignatureValue%2A> property uses a byte array to represent the `<SignatureValue>` element of an XML digital signature contained within.

For more information about XML digital signatures, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).

Expand Down Expand Up @@ -409,7 +409,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Security.Cryptography.Xml.Signature.SignedInfo%2A> property uses the <xref:System.Security.Cryptography.Xml.SignedInfo> class to represent the <`SignedInfo`> element of an XML digital signature contained within.
The <xref:System.Security.Cryptography.Xml.Signature.SignedInfo%2A> property uses the <xref:System.Security.Cryptography.Xml.SignedInfo> class to represent the `<SignedInfo>` element of an XML digital signature contained within.

For more information about XML digital signatures, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).

Expand Down
Loading