Skip to content

Document Org.Apache.Http.Client.Params - #585

Open
jonathanpeppers wants to merge 3 commits into
mainfrom
jonathanpeppers-document-http-client-params
Open

Document Org.Apache.Http.Client.Params#585
jonathanpeppers wants to merge 3 commits into
mainfrom
jonathanpeppers-document-http-client-params

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Closes#279

Sources

Validation

  • Parsed every docs/xml/Org.Apache.Http.Client.Params/*.xml file as XML.
  • Confirmed the scoped namespace contains no To be added placeholders and preserves CRLF line endings.
  • Ran git diff --check.

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 fills in XML documentation for types in the Org.Apache.Http.Client.Params namespace (addressing the “To be added.” placeholders noted in #279) by adding summaries/params/returns and standard Android/AOSP attribution content.

Changes:

  • Replaced placeholder summaries/params/returns with concrete documentation across AuthPolicy, CookiePolicy, ClientParamBean, and HttpClientParams.
  • Documented IClientPNames and its parameter-name constants, including an Android reference link and attribution.
  • Updated JniPeerMembers documentation to match the established infrastructure wording/value pattern.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/xml/Org.Apache.Http.Client.Params/IClientPNames.xmlAdds type/member docs and Android/AOSP attribution for client parameter name constants.
docs/xml/Org.Apache.Http.Client.Params/HttpClientParams.xmlDocuments key parameter accessors/mutators (params/returns) and infrastructure properties.
docs/xml/Org.Apache.Http.Client.Params/CookiePolicy.xmlReplaces placeholder summary and infrastructure property docs.
docs/xml/Org.Apache.Http.Client.Params/ClientParamBean.xmlDocuments constructor and configuration methods; replaces placeholders.
docs/xml/Org.Apache.Http.Client.Params/AuthPolicy.xmlReplaces placeholder summary and infrastructure property docs.

💡 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.Params/IClientPNames.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Two blockers remain in IClientPNames:

  • The eleven raw string keys omit the runtime value types consumed through untyped IHttpParams, and ConnectionManagerFactoryClassName incorrectly describes a connection-manager class rather than a factory class.
  • Each field publishes independently but has empty remarks, so the type-level AOSP/CC attribution is not inherited.

Please document each key's expected value type, correct the factory description, and add member-level attribution.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 12608efb-a04a-416a-b69e-9428779f04ab
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.

Add XML documentation for Org.Apache.Http.Client.Params

3 participants

@jonathanpeppers@dalexsoto