Skip to content

Commit f7b7891

Browse files
Automatic port of System.Formats.Asn1 documentation (dotnet#4668)
* Automatic port of System.Formats.As1 documentation * Apply suggestions from code review Co-authored-by: Jeremy Barton <[email protected]> Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Jeremy Barton <[email protected]>
1 parent 7c702bb commit f7b7891

File tree

9 files changed

+1731
-613
lines changed

9 files changed

+1731
-613
lines changed

xml/System.Formats.Asn1/Asn1Tag.xml

Lines changed: 103 additions & 69 deletions
Large diffs are not rendered by default.

xml/System.Formats.Asn1/AsnDecoder.xml

Lines changed: 721 additions & 229 deletions
Large diffs are not rendered by default.

xml/System.Formats.Asn1/AsnEncodingRules.xml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>To be added.</summary>
16+
<summary>The encoding ruleset for an <see cref="T:System.Formats.Asn1.AsnReader" /> or <see cref="T:System.Formats.Asn1.AsnWriter" />.</summary>
1717
<remarks>To be added.</remarks>
1818
</Docs>
1919
<Members>
@@ -34,7 +34,8 @@
3434
</ReturnValue>
3535
<MemberValue>0</MemberValue>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<summary>ITU-T X.690 Basic Encoding Rules</summary>
38+
<remarks>To be added.</remarks>
3839
</Docs>
3940
</Member>
4041
<Member MemberName="CER">
@@ -54,7 +55,8 @@
5455
</ReturnValue>
5556
<MemberValue>1</MemberValue>
5657
<Docs>
57-
<summary>To be added.</summary>
58+
<summary>ITU-T X.690 Canonical Encoding Rules</summary>
59+
<remarks>To be added.</remarks>
5860
</Docs>
5961
</Member>
6062
<Member MemberName="DER">
@@ -74,7 +76,8 @@
7476
</ReturnValue>
7577
<MemberValue>2</MemberValue>
7678
<Docs>
77-
<summary>To be added.</summary>
79+
<summary>ITU-T X.690 Distinguished Encoding Rules</summary>
80+
<remarks>To be added.</remarks>
7881
</Docs>
7982
</Member>
8083
</Members>

xml/System.Formats.Asn1/AsnReader.xml

Lines changed: 499 additions & 145 deletions
Large diffs are not rendered by default.

xml/System.Formats.Asn1/AsnReaderOptions.xml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Specifies options that modify the behavior of an <see cref="T:System.Formats.Asn1.AsnReader" />.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -34,8 +34,10 @@
3434
<ReturnType>System.Boolean</ReturnType>
3535
</ReturnValue>
3636
<Docs>
37-
<summary>To be added.</summary>
38-
<value>To be added.</value>
37+
<summary>Gets or sets a value that indicates whether the reader should bypass sort ordering on a Set or Set-Of value.</summary>
38+
<value>
39+
<see langword="true" /> if the reader should not validate that a Set or Set-Of value is sorted correctly for the current encoding rules; otherwise <see langword="false" />.
40+
The default is <see langword="false" />.</value>
3941
<remarks>To be added.</remarks>
4042
</Docs>
4143
</Member>
@@ -55,8 +57,8 @@
5557
<ReturnType>System.Int32</ReturnType>
5658
</ReturnValue>
5759
<Docs>
58-
<summary>To be added.</summary>
59-
<value>To be added.</value>
60+
<summary>Gets or sets the largest year to represent with a UtcTime value.</summary>
61+
<value>The largest year to represent with a UtcTime value. The default is 2049.</value>
6062
<remarks>To be added.</remarks>
6163
</Docs>
6264
</Member>

xml/System.Formats.Asn1/AsnWriter+Scope.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
</ReturnValue>
4343
<Parameters />
4444
<Docs>
45-
<summary>To be added.</summary>
45+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
4646
<remarks>To be added.</remarks>
4747
</Docs>
4848
</Member>

xml/System.Formats.Asn1/AsnWriter.xml

Lines changed: 301 additions & 113 deletions
Large diffs are not rendered by default.

xml/System.Formats.Asn1/TagClass.xml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>To be added.</summary>
16+
<summary>The tag class for a particular ASN.1 tag.</summary>
1717
<remarks>To be added.</remarks>
1818
</Docs>
1919
<Members>
@@ -34,7 +34,8 @@
3434
</ReturnValue>
3535
<MemberValue>64</MemberValue>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<summary>The Application tag class</summary>
38+
<remarks>To be added.</remarks>
3839
</Docs>
3940
</Member>
4041
<Member MemberName="ContextSpecific">
@@ -54,7 +55,8 @@
5455
</ReturnValue>
5556
<MemberValue>128</MemberValue>
5657
<Docs>
57-
<summary>To be added.</summary>
58+
<summary>The Context-Specific tag class</summary>
59+
<remarks>To be added.</remarks>
5860
</Docs>
5961
</Member>
6062
<Member MemberName="Private">
@@ -74,7 +76,8 @@
7476
</ReturnValue>
7577
<MemberValue>192</MemberValue>
7678
<Docs>
77-
<summary>To be added.</summary>
79+
<summary>The Private tag class</summary>
80+
<remarks>To be added.</remarks>
7881
</Docs>
7982
</Member>
8083
<Member MemberName="Universal">
@@ -94,7 +97,8 @@
9497
</ReturnValue>
9598
<MemberValue>0</MemberValue>
9699
<Docs>
97-
<summary>To be added.</summary>
100+
<summary>The Universal tag class</summary>
101+
<remarks>To be added.</remarks>
98102
</Docs>
99103
</Member>
100104
</Members>

0 commit comments

Comments
 (0)