Skip to content

Port System.Formats.Asn1 docs for .NET 9 #10576

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 2 commits into from
Oct 16, 2024
Merged

Port System.Formats.Asn1 docs for .NET 9 #10576

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6729d89
Add docs for DecodeLength and TryDecodeLength
vcsjones Oct 16, 2024
3f3b0fd
Apply suggestions from code review
bartonjs Oct 16, 2024
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
54 changes: 41 additions & 13 deletions xml/System.Formats.Asn1/AsnDecoder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,25 @@
<Parameter Name="bytesConsumed" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="ruleSet">To be added.</param>
<param name="bytesConsumed">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="source">The buffer containing encoded data.</param>
<param name="ruleSet">The encoding constraints to use when interpreting the data.</param>
<param name="bytesConsumed">
<para>When this method returns, contains the number of bytes from the beginning of <paramref name="source" /> that contributed to the length.</para>
<para>This parameter is treated as uninitialized.</para>
</param>
<summary>
<para>Decodes the data in <paramref name="source" /> as a length value under the specified encoding rules.</para>
</summary>
<returns>
<para>The decoded value of the length, or <see langword="null" /> if the encoded length represents the indefinite length.</para>
</returns>
<remarks>
<para>This method only processes the length portion of an ASN.1/BER Tag-Length-Value triplet, so <paramref name="source" /> needs to have already sliced off the encoded tag.</para>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="ruleSet" /> is not a known <see cref="T:System.Formats.Asn1.AsnEncodingRules" /> value.</exception>
<exception cref="T:System.Formats.Asn1.AsnContentException">
<paramref name="source" /> does not decode as a length under the specified encoding rules.</exception>
</Docs>
</Member>
<Member MemberName="ReadBitString">
Expand Down Expand Up @@ -1165,13 +1178,28 @@ The contents are not valid under the current encoding rules.</exception>
<Parameter Name="bytesConsumed" Type="System.Int32" RefType="out" Index="3" FrameworkAlternate="net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="ruleSet">To be added.</param>
<param name="decodedLength">To be added.</param>
<param name="bytesConsumed">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="source">The buffer containing encoded data.</param>
<param name="ruleSet">The encoding constraints to use when interpreting the data.</param>
<param name="decodedLength">
<para>When this method returns, contains the decoded value of the length, or <see langword="null" /> if the encoded length represents the indefinite length.</para>
<para>This parameter is treated as uninitialized.</para>
</param>
<param name="bytesConsumed">
<para>When this method returns, contains the number of bytes from the beginning of <paramref name="source" /> that contributed to the length.</para>
<para>This parameter is treated as uninitialized.</para>
</param>
<summary>
<para>Attempts to decode the data in <paramref name="source" /> as a length value under the specified encoding rules.</para>
</summary>
<returns>
<para>
<see langword="true" /> if the buffer represents a valid length under the specified encoding rules; otherwise, <see langword="false" /></para>
</returns>
<remarks>
<para>This method only processes the length portion of an ASN.1/BER Tag-Length-Value triplet, so <paramref name="source" /> needs to have already sliced off the encoded tag.</para>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="ruleSet" /> is not a known <see cref="T:System.Formats.Asn1.AsnEncodingRules" /> value.</exception>
</Docs>
</Member>
<Member MemberName="TryReadBitString">
Expand Down