Skip to content

Commit bed92ce

Browse files
authored
Improve documentation comments (#25)
1 parent a25a6e5 commit bed92ce

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

source/nanoFramework.System.Net.Http/Http/System.Net.HttpListener.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,14 @@ public class HttpListener
9595
private SslProtocols m_sslProtocols = SslProtocols.None;
9696

9797
/// <summary>
98-
/// Gets or sets the <see cref="SslProtocol"/> which shall be used.
98+
/// Gets or sets the TLS/SSL protocol used by the <see cref="HttpListener"/> class.
9999
/// </summary>
100+
/// <value>
101+
/// One of the values defined in the <see cref="Security.SslProtocols"/> enumeration.
102+
/// </value>
103+
/// <remarks>
104+
/// This property is specific to nanoFramework. There is no equivalent in the .NET API.
105+
/// </remarks>
100106
public SslProtocols SslProtocols
101107
{
102108
get { return m_sslProtocols; }

source/nanoFramework.System.Net.Http/Http/System.Net.HttpWebRequest.cs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,8 +363,16 @@ public X509Certificate HttpsAuthentCert
363363

364364

365365
/// <summary>
366-
/// Gets or sets the <see cref="SslProtocol"/> which shall be used for requests.
366+
/// Gets or sets the TLS/SSL protocol used by the <see cref="HttpWebRequest"/> class.
367367
/// </summary>
368+
/// <value>
369+
/// One of the values defined in the <see cref="Security.SslProtocols"/> enumeration.
370+
/// </value>
371+
/// <remarks>
372+
/// Setting this property is mandatory when performing HTTPS requests, otherwise the authentication will fail.
373+
///
374+
/// This property is specific to nanoFramework. There is no equivalent in the .NET API.
375+
/// </remarks>
368376
public SslProtocols SslProtocols
369377
{
370378
get { return m_sslProtocols; }

0 commit comments

Comments
 (0)