Skip to content

Document Apache HTTP connection parameters - #531

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-http-conn-params
Open

Document Apache HTTP connection parameters#531
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-http-conn-params

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Closes #274

Sources

Validation

  • Parsed every XML file in docs/xml/Org.Apache.Http.Conn.Params.
  • Confirmed CRLF line endings for every scoped XML file.
  • Confirmed zero scoped To be added placeholders.
  • Ran git diff --check.

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 replaces To be added. placeholders with XML documentation for types in Org.Apache.Http.Conn.Params, based on the Android API reference/AOSP sources and including the required AOSP/CC BY 2.5 attribution.

Changes:

  • Adds/updates <summary>, <param>, <returns>, and <value> documentation across the Org.Apache.Http.Conn.Params XML docs.
  • Adds CC BY 2.5 attribution <para> blocks in updated <remarks> sections.
  • Improves several API return/value descriptions (e.g., null semantics for ConnRouteParams getters).

Reviewed changes

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

Show a summary per file
File Description
docs/xml/Org.Apache.Http.Conn.Params/IConnRoutePNames.xml Replaces placeholders with interface/field documentation plus attribution.
docs/xml/Org.Apache.Http.Conn.Params/IConnPerRoute.xml Documents method parameter and return value plus attribution.
docs/xml/Org.Apache.Http.Conn.Params/IConnManagerPNames.xml Replaces placeholders with interface/field documentation plus attribution.
docs/xml/Org.Apache.Http.Conn.Params/IConnConnectionPNames.xml Replaces placeholders with interface/field documentation plus attribution.
docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParams+InterfaceConsts.xml Documents inherited constants summaries.
docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParams.xml Documents return/value semantics and updates infrastructure-related member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParamBean.xml Replaces placeholders for parameters and infrastructure-related member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnPerRouteBean.xml Documents parameters/returns and updates infrastructure-related member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParams+InterfaceConsts.xml Documents inherited constants summaries.
docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParams.xml Documents return/value semantics and updates infrastructure-related member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParamBean.xml Replaces placeholders for parameters and infrastructure-related member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnConnectionParamBean.xml Replaces placeholders for parameters and infrastructure-related member docs.

💡 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.Conn.Params/ConnRouteParams.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParams.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnPerRouteBean.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParamBean.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnConnectionParamBean.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParamBean.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 15, 2026 06:38
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

1 similar comment
@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.

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

2 participants