Updating method descriptions as per review suggestions

#17349
This commit is contained in:
Dairai Nyabando 2019-11-23 17:23:18 -05:00
parent 5dcb568df0
commit d2f2ed99fc
3 changed files with 11 additions and 11 deletions

View File

@ -29,7 +29,7 @@ namespace Microsoft.AspNetCore.Http
public static readonly string Trace = "TRACE"; public static readonly string Trace = "TRACE";
/// <summary> /// <summary>
/// Verifies the HTTP request method is CONNECT. /// Returns a value that indicates if the HTTP request method is CONNECT.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsConnect(string method) public static bool IsConnect(string method)
@ -38,7 +38,7 @@ namespace Microsoft.AspNetCore.Http
} }
/// <summary> /// <summary>
/// Verifies the HTTP request method is DELETE. /// Returns a value that indicates if the HTTP request method is DELETE.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsDelete(string method) public static bool IsDelete(string method)
@ -47,7 +47,7 @@ namespace Microsoft.AspNetCore.Http
} }
/// <summary> /// <summary>
/// Verifies the HTTP request method is GET. /// Returns a value that indicates if the HTTP request method is GET.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsGet(string method) public static bool IsGet(string method)
@ -56,7 +56,7 @@ namespace Microsoft.AspNetCore.Http
} }
/// <summary> /// <summary>
/// Verifies the HTTP request method is HEAD. /// Returns a value that indicates if the HTTP request method is HEAD.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsHead(string method) public static bool IsHead(string method)
@ -65,7 +65,7 @@ namespace Microsoft.AspNetCore.Http
} }
/// <summary> /// <summary>
/// Verifies the HTTP request method is OPTIONS. /// Returns a value that indicates if the HTTP request method is OPTIONS.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsOptions(string method) public static bool IsOptions(string method)
@ -74,7 +74,7 @@ namespace Microsoft.AspNetCore.Http
} }
/// <summary> /// <summary>
/// Verifies the HTTP request method is PATCH. /// Returns a value that indicates if the HTTP request method is PATCH.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsPatch(string method) public static bool IsPatch(string method)
@ -83,7 +83,7 @@ namespace Microsoft.AspNetCore.Http
} }
/// <summary> /// <summary>
/// Verifies the HTTP request method is POST. /// Returns a value that indicates if the HTTP request method is POST.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsPost(string method) public static bool IsPost(string method)
@ -92,7 +92,7 @@ namespace Microsoft.AspNetCore.Http
} }
/// <summary> /// <summary>
/// Verifies the HTTP request method is PUT. /// Returns a value that indicates if the HTTP request method is PUT.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsPut(string method) public static bool IsPut(string method)
@ -101,7 +101,7 @@ namespace Microsoft.AspNetCore.Http
} }
/// <summary> /// <summary>
/// Verifies the HTTP request method is TRACE. /// Returns a value that indicates if the HTTP request method is TRACE.
/// <summary/> /// <summary/>
/// <param name="method">HTTP request method.</param> /// <param name="method">HTTP request method.</param>
public static bool IsTrace(string method) public static bool IsTrace(string method)

View File

@ -29,7 +29,7 @@ namespace Microsoft.AspNetCore.HttpsPolicy
private readonly ILogger _logger; private readonly ILogger _logger;
/// <summary> /// <summary>
/// Initializes the HttpsRedirectionMiddleware. /// Initializes <see cref="HttpsRedirectionMiddleware" />.
/// </summary> /// </summary>
/// <param name="next"></param> /// <param name="next"></param>
/// <param name="options"></param> /// <param name="options"></param>

View File

@ -6,7 +6,7 @@ using Microsoft.AspNetCore.Http;
namespace Microsoft.AspNetCore.HttpsPolicy namespace Microsoft.AspNetCore.HttpsPolicy
{ {
/// <summary> /// <summary>
/// Options for the HttpsRedirection middleware. /// Options for the HTTPS Redirection Middleware.
/// </summary> /// </summary>
public class HttpsRedirectionOptions public class HttpsRedirectionOptions
{ {