Skip to content

Commit

Permalink
Fix incorrect paragraph elements in XML docs (dotnet#47817)
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesNK authored Apr 21, 2023
1 parent fca8088 commit 900660b
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 25 deletions.
34 changes: 18 additions & 16 deletions src/Middleware/HttpLogging/src/HttpLoggingFields.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ public enum HttpLoggingFields : long
/// <summary>
/// Flag for logging the HTTP Request Path, which includes both the <see cref="HttpRequest.Path"/>
/// and <see cref="HttpRequest.PathBase"/>.
/// <p>
/// <para>
/// For example:
/// Path: /index
/// PathBase: /app
/// </p>
/// </para>
/// </summary>
RequestPath = 0x1,

/// <summary>
/// Flag for logging the HTTP Request <see cref="HttpRequest.QueryString"/>.
/// <p>
/// <para>
/// For example:
/// Query: ?index=1
/// </p>
/// </para>
/// RequestQuery contents can contain private information
/// which may have regulatory concerns under GDPR
/// and other laws. RequestQuery should not be logged
Expand All @@ -45,37 +45,37 @@ public enum HttpLoggingFields : long

/// <summary>
/// Flag for logging the HTTP Request <see cref="HttpRequest.Protocol"/>.
/// <p>
/// <para>
/// For example:
/// Protocol: HTTP/1.1
/// </p>
/// </para>
/// </summary>
RequestProtocol = 0x4,

/// <summary>
/// Flag for logging the HTTP Request <see cref="HttpRequest.Method"/>.
/// <p>
/// <para>
/// For example:
/// Method: GET
/// </p>
/// </para>
/// </summary>
RequestMethod = 0x8,

/// <summary>
/// Flag for logging the HTTP Request <see cref="HttpRequest.Scheme"/>.
/// <p>
/// <para>
/// For example:
/// Scheme: https
/// </p>
/// </para>
/// </summary>
RequestScheme = 0x10,

/// <summary>
/// Flag for logging the HTTP Response <see cref="HttpResponse.StatusCode"/>.
/// <p>
/// <para>
/// For example:
/// StatusCode: 200
/// </p>
/// </para>
/// </summary>
ResponseStatusCode = 0x20,

Expand All @@ -84,11 +84,11 @@ public enum HttpLoggingFields : long
/// Request Headers are logged as soon as the middleware is invoked.
/// Headers are redacted by default with the character '[Redacted]' unless specified in
/// the <see cref="HttpLoggingOptions.RequestHeaders"/>.
/// <p>
/// <para>
/// For example:
/// Connection: keep-alive
/// My-Custom-Request-Header: [Redacted]
/// </p>
/// </para>
/// </summary>
RequestHeaders = 0x40,

Expand All @@ -97,13 +97,15 @@ public enum HttpLoggingFields : long
/// Response Headers are logged when the <see cref="HttpResponse.Body"/> is written to
/// or when <see cref="IHttpResponseBodyFeature.StartAsync(System.Threading.CancellationToken)"/>
/// is called.
/// <para>
/// Headers are redacted by default with the character '[Redacted]' unless specified in
/// the <see cref="HttpLoggingOptions.ResponseHeaders"/>.
/// <p>
/// </para>
/// <para>
/// For example:
/// Content-Length: 16
/// My-Custom-Response-Header: [Redacted]
/// </p>
/// </para>
/// </summary>
ResponseHeaders = 0x80,

Expand Down
12 changes: 6 additions & 6 deletions src/Middleware/HttpLogging/src/HttpLoggingOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ public sealed class HttpLoggingOptions

/// <summary>
/// Request header values that are allowed to be logged.
/// <p>
/// <para>
/// If a request header is not present in the <see cref="RequestHeaders"/>,
/// the header name will be logged with a redacted value.
/// Request headers can contain authentication tokens,
/// or private information which may have regulatory concerns
/// under GDPR and other laws. Arbitrary request headers
/// should not be logged unless logs are secure and
/// access controlled and the privacy impact assessed.
/// </p>
/// </para>
/// </summary>
public ISet<string> RequestHeaders => _internalRequestHeaders;

Expand Down Expand Up @@ -61,10 +61,10 @@ public sealed class HttpLoggingOptions

/// <summary>
/// Response header values that are allowed to be logged.
/// <p>
/// <para>
/// If a response header is not present in the <see cref="ResponseHeaders"/>,
/// the header name will be logged with a redacted value.
/// </p>
/// </para>
/// </summary>
public ISet<string> ResponseHeaders => _internalResponseHeaders;

Expand Down Expand Up @@ -93,10 +93,10 @@ public sealed class HttpLoggingOptions

/// <summary>
/// Options for configuring encodings for a specific media type.
/// <p>
/// <para>
/// If the request or response do not match the supported media type,
/// the response body will not be logged.
/// </p>
/// </para>
/// </summary>
public MediaTypeOptions MediaTypeOptions { get; } = MediaTypeOptions.BuildDefaultMediaTypeOptions();

Expand Down
6 changes: 3 additions & 3 deletions src/Middleware/HttpLogging/src/W3CLoggerOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public string FileName
}

/// <summary>
/// Gets or sets a string representing the directory where the log file will be written to
/// Gets or sets a string representing the directory where the log file will be written to.
/// Defaults to <c>./logs/</c> relative to the app directory (ContentRoot).
/// If a full path is given, that full path will be used. If a relative path is given,
/// the full path will be that path relative to ContentRoot.
Expand Down Expand Up @@ -110,13 +110,13 @@ public TimeSpan FlushInterval

/// <summary>
/// List of additional request header values to log.
/// <p>
/// <para>
/// Request headers can contain authentication tokens,
/// or private information which may have regulatory concerns
/// under GDPR and other laws. Arbitrary request headers
/// should not be logged unless logs are secure and
/// access controlled and the privacy impact assessed.
/// </p>
/// </para>
/// </summary>
public ISet<string> AdditionalRequestHeaders { get; } = new SortedSet<string>(StringComparer.OrdinalIgnoreCase);

Expand Down

0 comments on commit 900660b

Please sign in to comment.