Skip to content

Document Apache HTTP client methods - #589

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

Document Apache HTTP client methods#589
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-http-client-methods

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Documents authoritative request behavior, parameters, results, and namespace purpose for Org.Apache.Http.Client.Methods.
  • Leaves constructor summaries blank where the archived source provides no behavioral documentation; this PR therefore references, rather than closes, Add XML documentation for Org.Apache.Http.Client.Methods #299.

Refs #299

Sources

Validation

  • Parsed all 11 scoped type XML files and ns-Org.Apache.Http.Client.Methods.xml with PowerShell's XML parser.
  • Confirmed zero literal To be added. placeholders in the scoped files.
  • Confirmed CRLF line endings and a clean git diff --check.

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

CopilotAI 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 improves the generated XML documentation for the Org.Apache.Http.Client.Methods namespace by replacing placeholder docs with authoritative descriptions of request behavior, parameters, and return values, and by adding a namespace-level summary and reference link.

Changes:

  • Replaces To be added. placeholders across Apache HTTP client request types (e.g., method/URI/aborted state docs, constructor param docs).
  • Documents key request-base behaviors (e.g., cloning behavior, request line/protocol version, abort/callback hooks).
  • Adds namespace documentation (ns-Org.Apache.Http.Client.Methods.xml) including an Android reference link and attribution.

Reviewed changes

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

Show a summary per file
FileDescription
docs/xml/Org.Apache.Http.Client.Methods/IHttpUriRequest.xmlFills in placeholder property value docs (aborted/method/URI).
docs/xml/Org.Apache.Http.Client.Methods/IAbortableHttpRequest.xmlDocuments abort-related callback parameters.
docs/xml/Org.Apache.Http.Client.Methods/HttpTrace.xmlAdds constructor param docs and fills placeholder property docs.
docs/xml/Org.Apache.Http.Client.Methods/HttpRequestBase.xmlReplaces multiple placeholders for core request-base behavior (clone/aborted/method/version/request line/URI + abort hooks).
docs/xml/Org.Apache.Http.Client.Methods/HttpPut.xmlAdds constructor param docs and fills placeholder property docs.
docs/xml/Org.Apache.Http.Client.Methods/HttpPost.xmlAdds constructor param docs and fills placeholder property docs.
docs/xml/Org.Apache.Http.Client.Methods/HttpOptions.xmlAdds constructor param docs, documents Allow-header parsing, and fills placeholder property docs.
docs/xml/Org.Apache.Http.Client.Methods/HttpHead.xmlAdds constructor param docs and fills placeholder property docs.
docs/xml/Org.Apache.Http.Client.Methods/HttpGet.xmlAdds constructor param docs and fills placeholder property docs.
docs/xml/Org.Apache.Http.Client.Methods/HttpEntityEnclosingRequestBase.xmlDocuments enclosed entity property and expect-continue behavior + fills placeholder property docs.
docs/xml/Org.Apache.Http.Client.Methods/HttpDelete.xmlAdds constructor param docs and fills placeholder property docs.
docs/xml/ns-Org.Apache.Http.Client.Methods.xmlAdds namespace summary plus Android reference link and attribution.

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

Comment threaddocs/xml/Org.Apache.Http.Client.Methods/HttpGet.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Methods/HttpHead.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Methods/HttpPost.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Methods/HttpPut.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Methods/HttpTrace.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Methods/HttpEntityEnclosingRequestBase.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Methods/HttpRequestBase.xml Outdated
Comment threaddocs/xml/ns-Org.Apache.Http.Client.Methods.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Methods/IHttpUriRequest.xml Outdated
Comment threaddocs/xml/Org.Apache.Http.Client.Methods/HttpRequestBase.xml Outdated
Refs #299
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

Sign up for freeto 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

@jonathanpeppers