Skip to content

Commit 836f9f2

Browse files
authored
fix tag formatting (#2578)
* fix tag formatting * additional fix * feedback + markdig * fix indentation * change to clickable urls
1 parent a92f190 commit 836f9f2

File tree

42 files changed

+230
-225
lines changed

Some content is hidden

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

42 files changed

+230
-225
lines changed

xml/System.IdentityModel.Tokens/EncryptedKeyIdentifierClause.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@
256256
<format type="text/markdown"><![CDATA[
257257
258258
## Remarks
259-
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.
259+
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.
260260
261261
]]></format>
262262
</remarks>

xml/System.Security.Cryptography.Xml/CipherData.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
3737
3838
## Examples
39-
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.
39+
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.
4040
4141
[!code-cpp[cryptgraphy.Xml.EncryptedData#1](~/samples/snippets/cpp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/cpp/encrypteddata.cpp#1)]
4242
[!code-csharp[cryptgraphy.Xml.EncryptedData#1](~/samples/snippets/csharp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/CS/encrypteddata.cs#1)]

xml/System.Security.Cryptography.Xml/EncryptedXml.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@
398398
## Remarks
399399
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.
400400
401-
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.
401+
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.
402402
403403
404404
@@ -471,7 +471,7 @@
471471
[!code-csharp[Cryptography.XML.XMLEncMapKeyX509#1](~/samples/snippets/csharp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/CS/sample.cs#1)]
472472
[!code-vb[Cryptography.XML.XMLEncMapKeyX509#1](~/samples/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb#1)]
473473
474-
The following code example demonstrates how to decrypt a high level <`EncryptedData`> tag that contains another encrypted <`EncryptedData`> tag.
474+
The following code example demonstrates how to decrypt a high level `<EncryptedData>` tag that contains another encrypted `<EncryptedData>` tag.
475475
476476
[!code-csharp[Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption#1](~/samples/snippets/csharp/VS_Snippets_Misc/Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption/CS/sample.cs#1)]
477477
[!code-vb[Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption#1](~/samples/snippets/visualbasic/VS_Snippets_Misc/Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption/VB/sample.vb#1)]

xml/System.Security.Cryptography.Xml/KeyInfoX509Data.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@
546546
<format type="text/markdown"><![CDATA[
547547
548548
## Remarks
549-
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.
549+
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.
550550
551551
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.
552552

xml/System.Security.Cryptography.Xml/Signature.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
<format type="text/markdown"><![CDATA[
2828
2929
## Remarks
30-
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.
30+
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.
3131
32-
For more information about the <`Signature`> element, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).
32+
For more information about the `<Signature>` element, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).
3333
3434
3535
@@ -236,7 +236,7 @@
236236
<format type="text/markdown"><![CDATA[
237237
238238
## Remarks
239-
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.
239+
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.
240240
241241
For more information about XML digital signatures, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).
242242
@@ -329,7 +329,7 @@
329329
<format type="text/markdown"><![CDATA[
330330
331331
## Remarks
332-
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.
332+
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.
333333
334334
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.
335335
@@ -370,7 +370,7 @@
370370
<format type="text/markdown"><![CDATA[
371371
372372
## Remarks
373-
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.
373+
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.
374374
375375
For more information about XML digital signatures, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).
376376
@@ -409,7 +409,7 @@
409409
<format type="text/markdown"><![CDATA[
410410
411411
## Remarks
412-
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.
412+
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.
413413
414414
For more information about XML digital signatures, see the [W3C specification](https://www.w3.org/TR/xmldsig-core/).
415415

0 commit comments

Comments
 (0)