Skip to content

Commit f972e24

Browse files
Jan JahodaJan Jahodamairaw
authored
SslApplicationProtocol: update documentation (#4350)
* SslApplicationProtocol: update documention * Update xml/System.Net.Security/SslApplicationProtocol.xml Co-authored-by: Maira Wenzel <mairaw@microsoft.com> * Update xml/System.Net.Security/SslApplicationProtocol.xml Co-authored-by: Maira Wenzel <mairaw@microsoft.com> * Fix see reference * Add @ManickaP comments raised in #4367 * Remove space from remarks and Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Maira Wenzel <mairaw@microsoft.com>
1 parent c1bf75d commit f972e24

File tree

1 file changed

+59
-30
lines changed

1 file changed

+59
-30
lines changed

‎xml/System.Net.Security/SslApplicationProtocol.xml‎

Lines changed: 59 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,18 @@
3232
</Attribute>
3333
</Attributes>
3434
<Docs>
35-
<summary>To be added.</summary>
36-
<remarks>To be added.</remarks>
35+
<summary>Represents a values of TLS Application protocol.</summary>
36+
<remarks>
37+
<format type="text/markdown"><![CDATA[
38+
39+
## Remarks
40+
41+
For list of supported protocols, see [TLS Application-Layer Protocol Negotiation (ALPN) Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids).
42+
43+
This class contains static field with predefined <xref:System.Net.Security.SslApplicationProtocol> values for HTTP versions.
44+
45+
]]></format>
46+
</remarks>
3747
</Docs>
3848
<Members>
3949
<Member MemberName=".ctor">
@@ -58,8 +68,8 @@
5868
<Parameter Name="protocol" Type="System.Byte[]" />
5969
</Parameters>
6070
<Docs>
61-
<param name="protocol">To be added.</param>
62-
<summary>To be added.</summary>
71+
<param name="protocol">TLS Application protocol.</param>
72+
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslApplicationProtocol" />.</summary>
6373
<remarks>To be added.</remarks>
6474
</Docs>
6575
</Member>
@@ -85,8 +95,8 @@
8595
<Parameter Name="protocol" Type="System.String" />
8696
</Parameters>
8797
<Docs>
88-
<param name="protocol">To be added.</param>
89-
<summary>To be added.</summary>
98+
<param name="protocol">TLS Application protocol.</param>
99+
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.SslApplicationProtocol" />.</summary>
90100
<remarks>To be added.</remarks>
91101
</Docs>
92102
</Member>
@@ -118,9 +128,10 @@
118128
<Parameter Name="other" Type="System.Net.Security.SslApplicationProtocol" />
119129
</Parameters>
120130
<Docs>
121-
<param name="other">To be added.</param>
122-
<summary>To be added.</summary>
123-
<returns>To be added.</returns>
131+
<param name="other">The <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance to test for equality.</param>
132+
<summary>Compares a <see cref="T:System.Net.Security.SslApplicationProtocol" /> to the specified <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance.</summary>
133+
<returns>
134+
<see langword="true" /> if the <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance provided has matching data; otherwise, <see langword="false" />.</returns>
124135
<remarks>To be added.</remarks>
125136
</Docs>
126137
</Member>
@@ -149,9 +160,10 @@
149160
<Parameter Name="obj" Type="System.Object" />
150161
</Parameters>
151162
<Docs>
152-
<param name="obj">To be added.</param>
153-
<summary>To be added.</summary>
154-
<returns>To be added.</returns>
163+
<param name="obj">The object to test for equality.</param>
164+
<summary>Compares the <see cref="T:System.Net.Security.SslApplicationProtocol" /> to the specified object.</summary>
165+
<returns>
166+
<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>
155167
<remarks>To be added.</remarks>
156168
</Docs>
157169
</Member>
@@ -178,8 +190,8 @@
178190
</ReturnValue>
179191
<Parameters />
180192
<Docs>
181-
<summary>To be added.</summary>
182-
<returns>To be added.</returns>
193+
<summary>Returns the hash code for the <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance.</summary>
194+
<returns>A 32-bit signed integer hash code used to compare instances of this type.</returns>
183195
<remarks>To be added.</remarks>
184196
</Docs>
185197
</Member>
@@ -205,7 +217,9 @@
205217
<ReturnType>System.Net.Security.SslApplicationProtocol</ReturnType>
206218
</ReturnValue>
207219
<Docs>
208-
<summary>To be added.</summary>
220+
<summary>Gets a <see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/1.1 TLS application protocol.</summary>
221+
<value>
222+
<see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/1.1 TLS application protocol.</value>
209223
<remarks>To be added.</remarks>
210224
</Docs>
211225
</Member>
@@ -231,7 +245,9 @@
231245
<ReturnType>System.Net.Security.SslApplicationProtocol</ReturnType>
232246
</ReturnValue>
233247
<Docs>
234-
<summary>To be added.</summary>
248+
<summary>Gets a <see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/2 TLS application protocol.</summary>
249+
<value>
250+
<see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/2 TLS application protocol.</value>
235251
<remarks>To be added.</remarks>
236252
</Docs>
237253
</Member>
@@ -254,7 +270,9 @@
254270
<ReturnType>System.Net.Security.SslApplicationProtocol</ReturnType>
255271
</ReturnValue>
256272
<Docs>
257-
<summary>To be added.</summary>
273+
<summary>Gets a <see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/3 TLS application protocol.</summary>
274+
<value>
275+
<see cref="T:System.Net.Security.SslApplicationProtocol" /> representing HTTP/3 TLS application protocol.</value>
258276
<remarks>To be added.</remarks>
259277
</Docs>
260278
</Member>
@@ -284,10 +302,11 @@
284302
<Parameter Name="right" Type="System.Net.Security.SslApplicationProtocol" />
285303
</Parameters>
286304
<Docs>
287-
<param name="left">To be added.</param>
288-
<param name="right">To be added.</param>
289-
<summary>To be added.</summary>
290-
<returns>To be added.</returns>
305+
<param name="left">The left <see cref="T:System.Net.Security.SslApplicationProtocol" /> to an equality operator.</param>
306+
<param name="right">The right <see cref="T:System.Net.Security.SslApplicationProtocol" /> to an equality operator.</param>
307+
<summary>The equality operator for comparing two <see cref="T:System.Net.Security.SslApplicationProtocol" /> objects.</summary>
308+
<returns>
309+
<see langword="true" /> if the specified <paramref name="left" /> and <paramref name="right" /> parameters are equal; otherwise, <see langword="false" />.</returns>
291310
<remarks>To be added.</remarks>
292311
</Docs>
293312
</Member>
@@ -317,10 +336,11 @@
317336
<Parameter Name="right" Type="System.Net.Security.SslApplicationProtocol" />
318337
</Parameters>
319338
<Docs>
320-
<param name="left">To be added.</param>
321-
<param name="right">To be added.</param>
322-
<summary>To be added.</summary>
323-
<returns>To be added.</returns>
339+
<param name="left">The left <see cref="T:System.Net.Security.SslApplicationProtocol" /> to an inequality operator.</param>
340+
<param name="right">The right <see cref="T:System.Net.Security.SslApplicationProtocol" /> to an inequality operator.</param>
341+
<summary>The inequality operator for comparing two <see cref="T:System.Net.Security.SslApplicationProtocol" /> objects.</summary>
342+
<returns>
343+
<see langword="true" /> if the specified <paramref name="left" /> and <paramref name="right" /> parameters are inequal; otherwise, <see langword="false" />.</returns>
324344
<remarks>To be added.</remarks>
325345
</Docs>
326346
</Member>
@@ -346,8 +366,9 @@
346366
<ReturnType>System.ReadOnlyMemory&lt;System.Byte&gt;</ReturnType>
347367
</ReturnValue>
348368
<Docs>
349-
<summary>To be added.</summary>
350-
<value>To be added.</value>
369+
<summary>Gets a current TLS application protocol represented by this <see cref="T:System.Net.Security.SslApplicationProtocol" />.</summary>
370+
<value>
371+
The read-only byte memory representing a TLS application protocol.</value>
351372
<remarks>To be added.</remarks>
352373
</Docs>
353374
</Member>
@@ -374,9 +395,17 @@
374395
</ReturnValue>
375396
<Parameters />
376397
<Docs>
377-
<summary>To be added.</summary>
378-
<returns>To be added.</returns>
379-
<remarks>To be added.</remarks>
398+
<summary>Overrides the <see cref="M:System.Object.ToString" /> method.</summary>
399+
<returns>Returns a string representation of this <see cref="T:System.Net.Security.SslApplicationProtocol" /> object.</returns>
400+
<remarks>
401+
<format type="text/markdown"><![CDATA[
402+
403+
## Remarks
404+
405+
If the <xref:System.Net.Security.SslApplicationProtocol.Protocol?displayProperty=nameWithType> contains valid UTF-8 bytes, `ToString` returns the text representation of the value; otherwise, the hex representation.
406+
407+
]]></format>
408+
</remarks>
380409
</Docs>
381410
</Member>
382411
</Members>

0 commit comments

Comments
 (0)