Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback #4861
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@geoffkizer, can you please review/edit the doc? I'm sure you will find more accurate way how to describe this API. I will appreciate any suggestion. |
This comment has been minimized.
This comment has been minimized.
|
There are xml doc comments for this stuff -- shouldn't they be getting picked up? |
|
As far as I know they should be picked the first time the xml stub for the new API is created. I updated it according the comments from the source. |
This comment has been minimized.
This comment has been minimized.
That's not quite true, we don't bring in the comments when we create the stubs. But @carlossanlop has a DocsPortingTool you can use to import the doc comments after the stubs are in place. If we imported doc comments with the stubs, then any existing comments in the docs would be overwritten across all the docs. |
gewarren
approved these changes
Sep 17, 2020
|
Proposed changes from @gewarren look good to me. |
|
Oops. |
|
Docs Build status updates of commit 4788b21: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
|
Docs Build status updates of commit 5fb870a: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
gewarren
added a commit
to gewarren/dotnet-api-docs
that referenced
this pull request
Sep 24, 2020
…otnet#4861) * Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback * Apply PR comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
carlossanlop
added a commit
that referenced
this pull request
Sep 24, 2020
* Automatic port of System.OperatingSystem docs for RC2 (#4852) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Add Missing System.Diagnostics docs (#4856) * Add Missing System.Diagnostics docs * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Automatically port System.Diagnostics docs for RC2 (#4853) * Automatically port System.Diagnostics docs for RC2 * Update xml/System.Diagnostics/ActivitySamplingResult.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Update xml/System.Diagnostics/Process.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com> * Automatic port of RegexParse* documentation (#4850) * Automatic port of RegexParse* documentation * Update xml/System.Text.RegularExpressions/RegexParseError.xml * Apply suggestions from code review * Update RegexParseException * Update xml/System.Text.RegularExpressions/RegexParseException.xml * Update xml/System.Text.RegularExpressions/RegexParseException.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> * Add ssl API added between preview 7 and 8 (#4860) * Automatic port of Reflection RC2 documentation (#4851) * Revert "Add ssl API added between preview 7 and 8 (#4860)" (#4868) This reverts commit 10d2b88. * Add ssl API added between preview 7 and 8 #2 (#4869) * Add ssl API added between preview 7 and 8 * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Update xml/System.Net.Security/SslStream.xml * Apply @wfurt comments * Add missing remark headers * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback (#4861) * Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback * Apply PR comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Add a remark to AddEvent method (#4871) * Add a remark to AddEvent method * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Automatic port of CryptoStream docs (#4888) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Automatic port of System.Buffers docs (#4882) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * resolve isprefix conflict * Automatic port of System.Data.Common docs (#4885) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Automatic port of *PipeServerStreamAcl docs (#4880) * Automatic port of *PipeServerStreamAcl docs * Apply suggestions from code review Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> Co-authored-by: David Cantú <dacantu@microsoft.com> * Apply suggestions from code review Co-authored-by: David Cantú <dacantu@microsoft.com> * Apply suggestions from code review * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> Co-authored-by: David Cantú <dacantu@microsoft.com> * Automatic port of *OSPlatformAttribute docs (#4883) * Automatic port of *OSPlatformAttribute docs * Missing TargetPlatformAttribute constructor parameter description. * Apply suggestions from code review Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com> * Update xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com> * Document System.Enum (#4894) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Document Half.op_Explicit APIs (#4893) * Document Half.op_Explicit APIs * Equals Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Automatic port of Rune.CompareTo EII (#4891) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Add missing docs for AsnContentException. (#4895) * Add missing documentation for S.S.Cryptography (#4892) * Add missing documentation for S.S.Cryptography * Apply feedback * Automatic port of System.Threading.ExecutionContext.Restore doc (#4887) * Automatic port of System.Threading.ExecutionContext.Restore doc * Update xml/System.Threading/ExecutionContext.xml Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> * Apply suggestions from code review Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> * Automatic port of explicit interface implementation of System.Net.Http.HttpRequestOptions (#4881) * Automatic port of explicit interface implementations for System.Net.Http.HttpRequestOptions * Apply suggestions from code review Co-authored-by: Jan Jahoda <aik.jahoda@post.cz> Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Jan Jahoda <aik.jahoda@post.cz> * Document Type.IsAssignableTo (#4898) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Document System.PlatformID.Other (#4897) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * HTTP Version Selection (#4870) * Sync docs with source comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Add values Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * HttpClient sync operations (#4776) * Draft for @ManickaP * Apply suggestions from code review Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com> * Format verification * Format verification * Fix links * Fix links * Fix xml tag * Fix links * Fix links * Fix links * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Fix links * Add CreateContentReadStream * Fix links * Add System.Net.Http.DelegatingHandler.Send * Fix links * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Remove "Synchronous" information from summary * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Fix the exception description Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * adding docs for missing 5.0 apis for system.Runtime.CompilerServices.Unsafe (#4902) * adding docs for missing 5.0 apis * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * resolve conflict * Add Sysytem.Net.* missing API (#4904) * System.Net.Http.SocketsHttpHandler.EnableMultipleHttp2Connections * Add Sysytem.Net.\* missing API * Apply PR comments * Apply suggestions from code review * Apply suggestions from code review * Update xml/System.Net.Http/SocketsHttpHandler.xml Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Http sync follow up (#4905) * Add the http sync follow up * Fix closing tag Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> Co-authored-by: Jan Jahoda <jajahoda@microsoft.com> Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: David Cantú <dacantu@microsoft.com> Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com> Co-authored-by: Jeremy Barton <jbarton@microsoft.com> Co-authored-by: Jan Jahoda <aik.jahoda@post.cz> Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com> Co-authored-by: Anirudh Agnihotry <anirudhagnihotry098@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Documentation of System.Net.Http.SocketsHttpHandler.ConnectCallback introduced in dotnet/runtime#41955