Skip to content

SslApplicationProtocol: update documentation #4350

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 6 commits into from
Jun 16, 2020
Merged

SslApplicationProtocol: update documentation #4350

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cadab28
SslApplicationProtocol: update documention
Jun 9, 2020
bb83263
Update xml/System.Net.Security/SslApplicationProtocol.xml
aik-jahoda Jun 10, 2020
b84ac7a
Update xml/System.Net.Security/SslApplicationProtocol.xml
aik-jahoda Jun 11, 2020
f0f5908
Fix see reference
Jun 12, 2020
8c178e9
Add @manickap comments raised in #4367
Jun 15, 2020
96f9e32
Remove space from remarks and
Jun 16, 2020
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
71 changes: 42 additions & 29 deletions xml/System.Net.Security/SslApplicationProtocol.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Represents a values of TLS Application protocol.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -58,8 +58,8 @@
<Parameter Name="protocol" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="protocol">To be added.</param>
<summary>To be added.</summary>
<param name="protocol">TLS Application protocol.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslApplicationProtocol" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -85,8 +85,8 @@
<Parameter Name="protocol" Type="System.String" />
</Parameters>
<Docs>
<param name="protocol">To be added.</param>
<summary>To be added.</summary>
<param name="protocol">TLS Application protocol.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslApplicationProtocol" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -118,9 +118,10 @@
<Parameter Name="other" Type="System.Net.Security.SslApplicationProtocol" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="other">The <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance to test for equality.</param>
<summary>Compares a <see cref="T:System.Net.Security.SslApplicationProtocol" /> to the specified <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance provided has matching data; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -149,9 +150,10 @@
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="obj">The object to test for equality.</param>
<summary>Compares the <see cref="T:System.Net.Security.SslApplicationProtocol" /> to the specified object.</summary>
<returns>
<see langword="true" /> if <paramref name="obj" /> is a <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance, and the <see cref="T:System.Net.Security.SslApplicationProtocol" /> instances have matching data; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -178,8 +180,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns the hash code for the <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance.</summary>
<returns>A 32-bit signed integer hash code used to compare instances of this type.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -205,7 +207,9 @@
<ReturnType>System.Net.Security.SslApplicationProtocol</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a <see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/1.1 TLS application protocol.</summary>
<value>
<see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/1.1 TLS application protocol.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -231,7 +235,9 @@
<ReturnType>System.Net.Security.SslApplicationProtocol</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a <see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/2 TLS application protocol.</summary>
<value>
<see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/2 TLS application protocol.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -254,7 +260,9 @@
<ReturnType>System.Net.Security.SslApplicationProtocol</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a <see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/3 TLS application protocol.</summary>
<value>
<see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/3 TLS application protocol.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -284,10 +292,11 @@
<Parameter Name="right" Type="System.Net.Security.SslApplicationProtocol" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="left">The left <see cref="T:System.Net.Security.SslApplicationProtocol" /> to an equality operator.</param>
<param name="right">The right <see cref="T:System.Net.Security.SslApplicationProtocol" /> to an equality operator.</param>
<summary>The equality operator for comparing two <see cref="T:System.Net.Security.SslApplicationProtocol" /> objects.</summary>
<returns>
<see langword="true" /> if the specified <paramref name="left" /> and <paramref name="right" /> parameters are equal; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -317,10 +326,11 @@
<Parameter Name="right" Type="System.Net.Security.SslApplicationProtocol" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="left">The left <see cref="T:System.Net.Security.SslApplicationProtocol" /> to an inequality operator.</param>
<param name="right">The right <see cref="T:System.Net.Security.SslApplicationProtocol" /> to an inequality operator.</param>
<summary>The inequality operator for comparing two <see cref="T:System.Net.Security.SslApplicationProtocol" /> objects.</summary>
<returns>
<see langword="true" /> if the specified <paramref name="left" /> and <paramref name="right" /> parameters are inequal; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -346,8 +356,9 @@
<ReturnType>System.ReadOnlyMemory&lt;System.Byte&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>>Gets a current TLS application protocol represented by this <see cref="T:System.Net.Security.SslApplicationProtocol" />.</summary>
<value>
<see cref="T:System.ReadOnlyMemory&lt;System.Byte&gt;" /> representing a TLS application protocol.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -374,9 +385,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Overrides the <see cref="M:System.Object.ToString" /> method.</summary>
<returns>Returns a string representation of this <see cref="T:System.Net.Security.SslApplicationProtocol" /> object.</returns>
<remarks>
If the <xref:System.Net.Security.SslApplicationProtocol.Protocol> contains a valid UTF8 bytes it will retrun text representation othervise hex representation of the value.
</remarks>
</Docs>
</Member>
</Members>
Expand Down