Skip to content

Commit 900660b

Browse files
authored
Fix incorrect paragraph elements in XML docs (#47817)
1 parent fca8088 commit 900660b

File tree

3 files changed

+27
-25
lines changed

3 files changed

+27
-25
lines changed

src/Middleware/HttpLogging/src/HttpLoggingFields.cs

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ public enum HttpLoggingFields : long
2121
/// <summary>
2222
/// Flag for logging the HTTP Request Path, which includes both the <see cref="HttpRequest.Path"/>
2323
/// and <see cref="HttpRequest.PathBase"/>.
24-
/// <p>
24+
/// <para>
2525
/// For example:
2626
/// Path: /index
2727
/// PathBase: /app
28-
/// </p>
28+
/// </para>
2929
/// </summary>
3030
RequestPath = 0x1,
3131

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

4646
/// <summary>
4747
/// Flag for logging the HTTP Request <see cref="HttpRequest.Protocol"/>.
48-
/// <p>
48+
/// <para>
4949
/// For example:
5050
/// Protocol: HTTP/1.1
51-
/// </p>
51+
/// </para>
5252
/// </summary>
5353
RequestProtocol = 0x4,
5454

5555
/// <summary>
5656
/// Flag for logging the HTTP Request <see cref="HttpRequest.Method"/>.
57-
/// <p>
57+
/// <para>
5858
/// For example:
5959
/// Method: GET
60-
/// </p>
60+
/// </para>
6161
/// </summary>
6262
RequestMethod = 0x8,
6363

6464
/// <summary>
6565
/// Flag for logging the HTTP Request <see cref="HttpRequest.Scheme"/>.
66-
/// <p>
66+
/// <para>
6767
/// For example:
6868
/// Scheme: https
69-
/// </p>
69+
/// </para>
7070
/// </summary>
7171
RequestScheme = 0x10,
7272

7373
/// <summary>
7474
/// Flag for logging the HTTP Response <see cref="HttpResponse.StatusCode"/>.
75-
/// <p>
75+
/// <para>
7676
/// For example:
7777
/// StatusCode: 200
78-
/// </p>
78+
/// </para>
7979
/// </summary>
8080
ResponseStatusCode = 0x20,
8181

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

@@ -97,13 +97,15 @@ public enum HttpLoggingFields : long
9797
/// Response Headers are logged when the <see cref="HttpResponse.Body"/> is written to
9898
/// or when <see cref="IHttpResponseBodyFeature.StartAsync(System.Threading.CancellationToken)"/>
9999
/// is called.
100+
/// <para>
100101
/// Headers are redacted by default with the character '[Redacted]' unless specified in
101102
/// the <see cref="HttpLoggingOptions.ResponseHeaders"/>.
102-
/// <p>
103+
/// </para>
104+
/// <para>
103105
/// For example:
104106
/// Content-Length: 16
105107
/// My-Custom-Response-Header: [Redacted]
106-
/// </p>
108+
/// </para>
107109
/// </summary>
108110
ResponseHeaders = 0x80,
109111

src/Middleware/HttpLogging/src/HttpLoggingOptions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ public sealed class HttpLoggingOptions
1717

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

@@ -61,10 +61,10 @@ public sealed class HttpLoggingOptions
6161

6262
/// <summary>
6363
/// Response header values that are allowed to be logged.
64-
/// <p>
64+
/// <para>
6565
/// If a response header is not present in the <see cref="ResponseHeaders"/>,
6666
/// the header name will be logged with a redacted value.
67-
/// </p>
67+
/// </para>
6868
/// </summary>
6969
public ISet<string> ResponseHeaders => _internalResponseHeaders;
7070

@@ -93,10 +93,10 @@ public sealed class HttpLoggingOptions
9393

9494
/// <summary>
9595
/// Options for configuring encodings for a specific media type.
96-
/// <p>
96+
/// <para>
9797
/// If the request or response do not match the supported media type,
9898
/// the response body will not be logged.
99-
/// </p>
99+
/// </para>
100100
/// </summary>
101101
public MediaTypeOptions MediaTypeOptions { get; } = MediaTypeOptions.BuildDefaultMediaTypeOptions();
102102

src/Middleware/HttpLogging/src/W3CLoggerOptions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public string FileName
7373
}
7474

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

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

0 commit comments

Comments
 (0)