From bc8109c2920f2ca53eb51362b78432c1d4dc1ec1 Mon Sep 17 00:00:00 2001 From: Natalia Kondratyeva Date: Fri, 3 Sep 2021 15:47:57 +0200 Subject: [PATCH 1/2] Port triple-slash comments to docs for Microsoft.Extensions.Http --- .../LoggingHttpMessageHandler.xml | 26 ++++++++++++++----- .../LoggingScopeHttpMessageHandler.xml | 26 ++++++++++++++----- .../HttpMessageHandlerBuilder.xml | 14 +++++++--- .../IHttpMessageHandlerBuilderFilter.xml | 2 +- 4 files changed, 49 insertions(+), 19 deletions(-) diff --git a/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml index ac4ab1b878a..b7e291e97d6 100644 --- a/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml @@ -19,7 +19,7 @@ - To be added. + Handles logging of the lifecycle for an HTTP request. To be added. @@ -44,9 +44,11 @@ - To be added. - To be added. + The to log to. + Initializes a new instance of the class with a specified logger. To be added. + + is . @@ -67,10 +69,12 @@ - To be added. - To be added. - To be added. + The to log to. + The used to configure the instance. + Initializes a new instance of the class with a specified logger and options. To be added. + + or is . @@ -108,7 +112,15 @@ To be added. To be added. To be added. - To be added. + + . + + ]]> + diff --git a/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml index 1fc1e3c714a..b082d78a67a 100644 --- a/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml @@ -19,7 +19,7 @@ - To be added. + Handles logging of the lifecycle for an HTTP request within a log scope. To be added. @@ -44,9 +44,11 @@ - To be added. - To be added. + The to log to. + Initializes a new instance of the class with a specified logger. To be added. + + is . @@ -67,10 +69,12 @@ - To be added. - To be added. - To be added. + The to log to. + The used to configure the instance. + Initializes a new instance of the class with a specified logger and options. To be added. + + or is . @@ -108,7 +112,15 @@ To be added. To be added. To be added. - To be added. + + . + + ]]> + diff --git a/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml b/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml index a6678a57eb1..3ea9484a924 100644 --- a/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml +++ b/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml @@ -129,11 +129,17 @@ - To be added. - To be added. - To be added. - To be added. + An instance of to operate at the bottom of the handler chain and actually handle the HTTP transport operations. + An ordered list of instances to be invoked as part of sending an and receiving an . + The handlers are invoked in a top-down fashion. That is, the first entry is invoked first for an outbound request message but last for an inbound response message. + Constructs an instance of by chaining one after another with in the end of the chain. The resulting pipeline is used by infrastructure to create instances with customized message handlers. The resulting pipeline can also be accessed by using instead of . + The HTTP message handler chain. To be added. + + or is . + + contains a entry. + -or- The DelegatingHandler.InnerHandler property must be . DelegatingHandler instances provided to HttpMessageHandlerBuilder must not be reused or cached. diff --git a/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml b/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml index 1c3613c2a03..91af4c3c82e 100644 --- a/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml +++ b/xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml @@ -47,7 +47,7 @@ A delegate which will run the next . Applies additional initialization to the . - To be added. + The configured . To be added. From 8b0110f6e01289660db56264e6f79379c9fa80fc Mon Sep 17 00:00:00 2001 From: Natalia Kondratyeva Date: Mon, 6 Sep 2021 19:15:12 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../LoggingHttpMessageHandler.xml | 3 ++- .../LoggingScopeHttpMessageHandler.xml | 3 ++- xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml | 5 ++++- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml index b7e291e97d6..f296cebea7a 100644 --- a/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml @@ -117,10 +117,11 @@ ## Remarks -Loggs the request to and response from the sent . +Logs the request and response from the sent . ]]> + diff --git a/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml b/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml index b082d78a67a..807df72583a 100644 --- a/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml +++ b/xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml @@ -117,10 +117,11 @@ ## Remarks -Loggs the request to and response from the sent . +Logs the request and response from the sent . ]]> + diff --git a/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml b/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml index 3ea9484a924..db002c1235c 100644 --- a/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml +++ b/xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml @@ -139,7 +139,10 @@ or is . contains a entry. - -or- The DelegatingHandler.InnerHandler property must be . DelegatingHandler instances provided to HttpMessageHandlerBuilder must not be reused or cached. + +-or- + +DelegatingHandler.InnerHandler is not . DelegatingHandler instances provided to HttpMessageHandlerBuilder must not be reused or cached.