Skip to content

Port triple-slash comments to docs for Microsoft.Extensions.Http #7103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 7, 2021
Merged

Port triple-slash comments to docs for Microsoft.Extensions.Http #7103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc8109c
Port triple-slash comments to docs for Microsoft.Extensions.Http
CarnaViire Sep 3, 2021
8b0110f
Apply suggestions from code review
CarnaViire Sep 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions xml/Microsoft.Extensions.Http.Logging/LoggingHttpMessageHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Handles logging of the lifecycle for an HTTP request.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -44,9 +44,11 @@
<Parameter Name="logger" Type="Microsoft.Extensions.Logging.ILogger" />
</Parameters>
<Docs>
<param name="logger">To be added.</param>
<summary>To be added.</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to log to.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler" /> class with a specified logger.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="logger" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand All @@ -67,10 +69,12 @@
<Parameter Name="options" Type="Microsoft.Extensions.Http.HttpClientFactoryOptions" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0;dotnet-plat-ext-6.0" />
</Parameters>
<Docs>
<param name="logger">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to log to.</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Http.HttpClientFactoryOptions" /> used to configure the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler" /> instance.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler" /> class with a specified logger and options.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="logger" /> or <paramref name="options" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="SendAsync">
Expand Down Expand Up @@ -108,7 +112,16 @@
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Logs the request and response from the sent <xref:System.Net.Http.HttpRequestMessage>.

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
27 changes: 20 additions & 7 deletions xml/Microsoft.Extensions.Http.Logging/LoggingScopeHttpMessageHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Handles logging of the lifecycle for an HTTP request within a log scope.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -44,9 +44,11 @@
<Parameter Name="logger" Type="Microsoft.Extensions.Logging.ILogger" />
</Parameters>
<Docs>
<param name="logger">To be added.</param>
<summary>To be added.</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to log to.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler" /> class with a specified logger.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="logger" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand All @@ -67,10 +69,12 @@
<Parameter Name="options" Type="Microsoft.Extensions.Http.HttpClientFactoryOptions" Index="1" FrameworkAlternate="dotnet-plat-ext-5.0;dotnet-plat-ext-6.0" />
</Parameters>
<Docs>
<param name="logger">To be added.</param>
<param name="options">To be added.</param>
<summary>To be added.</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to log to.</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Http.HttpClientFactoryOptions" /> used to configure the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler" /> instance.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler" /> class with a specified logger and options.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="logger" /> or <paramref name="options" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="SendAsync">
Expand Down Expand Up @@ -108,7 +112,16 @@
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Logs the request and response from the sent <xref:System.Net.Http.HttpRequestMessage>.

]]></format>
</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
Expand Down
17 changes: 13 additions & 4 deletions xml/Microsoft.Extensions.Http/HttpMessageHandlerBuilder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,20 @@
<Parameter Name="additionalHandlers" Type="System.Collections.Generic.IEnumerable&lt;System.Net.Http.DelegatingHandler&gt;" />
</Parameters>
<Docs>
<param name="primaryHandler">To be added.</param>
<param name="additionalHandlers">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="primaryHandler">An instance of <see cref="T:System.Net.Http.HttpMessageHandler" /> to operate at the bottom of the handler chain and actually handle the HTTP transport operations.</param>
<param name="additionalHandlers">An ordered list of <see cref="T:System.Net.Http.DelegatingHandler" /> instances to be invoked as part of sending an <see cref="T:System.Net.Http.HttpRequestMessage" /> and receiving an <see cref="T:System.Net.Http.HttpResponseMessage" />.
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.</param>
<summary>Constructs an instance of <see cref="T:System.Net.Http.HttpMessageHandler" /> by chaining <paramref name="additionalHandlers" /> one after another with <paramref name="primaryHandler" /> in the end of the chain. The resulting pipeline is used by <see cref="T:System.Net.Http.IHttpClientFactory" /> infrastructure to create <see cref="T:System.Net.Http.HttpClient" /> instances with customized message handlers. The resulting pipeline can also be accessed by using <see cref="T:System.Net.Http.IHttpMessageHandlerFactory" /> instead of <see cref="T:System.Net.Http.IHttpClientFactory" />.</summary>
<returns>The HTTP message handler chain.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="primaryHandler " /> or <paramref name="additionalHandlers " /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<paramref name="additionalHandlers " /> contains a <see langword="null" /> entry.

-or-

<c>DelegatingHandler.InnerHandler</c> is not <see langword="null" />. <c>DelegatingHandler</c> instances provided to <c>HttpMessageHandlerBuilder</c> must not be reused or cached.</exception>
</Docs>
</Member>
<Member MemberName="Name">
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<Docs>
<param name="next">A delegate which will run the next <see cref="T:Microsoft.Extensions.Http.IHttpMessageHandlerBuilderFilter" />.</param>
<summary>Applies additional initialization to the <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder" />.</summary>
<returns>To be added.</returns>
<returns>The configured <see cref="T:Microsoft.Extensions.Http.HttpMessageHandlerBuilder" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down