Skip to content

Document Apache HTTP client APIs - #428

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-apache-http-client
Open

Document Apache HTTP client APIs#428
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-apache-http-client

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

Refs #270

Sources

Validation

  • Parsed all 16 scoped XML files with PowerShell [xml].
  • Confirmed CRLF line endings for all 16 scoped XML files.
  • Ran git diff --check and verified the diff is limited to docs/xml/Org.Apache.Http.Client/ and docs/xml/ns-Org.Apache.Http.Client.xml.
  • Counted scoped To be added. placeholders: 117 before, 30 after.

Refs #270

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fills in previously placeholder XML documentation for the Org.Apache.Http.Client namespace, using source-supported descriptions where available, and adds a namespace-level summary to improve generated API docs.

Changes:

  • Replace multiple To be added. placeholders with concrete <summary>, <param>, <returns>, and <value> documentation across key Org.Apache.Http.Client types.
  • Add a meaningful namespace summary in ns-Org.Apache.Http.Client.xml.
  • Improve documentation for async extension methods on IHttpClient.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/xml/Org.Apache.Http.Client/RedirectException.xml Documents constructor parameters for RedirectException.
docs/xml/Org.Apache.Http.Client/NonRepeatableRequestException.xml Documents constructor parameter for NonRepeatableRequestException.
docs/xml/Org.Apache.Http.Client/IUserTokenHandler.xml Replaces placeholder return docs with a meaningful description.
docs/xml/Org.Apache.Http.Client/IResponseHandler.xml Documents return value semantics for response handler processing.
docs/xml/Org.Apache.Http.Client/IRequestDirector.xml Documents return value semantics for request execution.
docs/xml/Org.Apache.Http.Client/IRedirectHandler.xml Documents return values for redirect determination methods.
docs/xml/Org.Apache.Http.Client/IHttpRequestRetryHandler.xml Documents boolean return value for retry decisions.
docs/xml/Org.Apache.Http.Client/IHttpClientExtensions.xml Adds docs for async IHttpClient extension methods (params/summaries/returns).
docs/xml/Org.Apache.Http.Client/IHttpClient.xml Adds missing <returns>/<value> docs for core client members.
docs/xml/Org.Apache.Http.Client/ICredentialsProvider.xml Documents credentials lookup return value.
docs/xml/Org.Apache.Http.Client/ICookieStore.xml Documents cookie store parameter/return/value semantics.
docs/xml/Org.Apache.Http.Client/CircularRedirectException.xml Documents constructor parameters for CircularRedirectException.
docs/xml/ns-Org.Apache.Http.Client.xml Adds namespace-level summary text.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Org.Apache.Http.Client/NonRepeatableRequestException.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Client/ICookieStore.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Client/RedirectException.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Client/CircularRedirectException.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 14, 2026 09:18
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants