Skip to content

Document Org.Apache.Http.Conn.Params - #572

Closed
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-connection-params
Closed

Document Org.Apache.Http.Conn.Params#572
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-connection-params

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Documents the Org.Apache.Http.Conn.Params connection, route, and connection-manager parameter APIs.
  • Documents compatibility constants, parameter beans, per-route limits, and JNI peer metadata.
  • Preserves the required Android Open Source Project Creative Commons Attribution 2.5 attribution.

Closes #274

Sources

Validation

  • Parsed all 15 docs/xml/Org.Apache.Http.Conn.Params/*.xml files with PowerShell XML parsing.
  • Verified all scoped XML files use CRLF line endings.
  • Verified To be added. has zero matches in docs/xml/Org.Apache.Http.Conn.Params.
  • Ran git diff --check and verified only 12 scoped XML files changed.

Closes #274

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 updates the generated XML documentation for the Org.Apache.Http.Conn.Params namespace, replacing “To be added.” placeholders with real documentation for connection, route, and connection-manager parameter APIs (closing #274).

Changes:

  • Replaced placeholder <summary>, <param>, <returns>, and <value> documentation across the Org.Apache.Http.Conn.Params XML docs.
  • Added/updated documentation for parameter-name constants, parameter-bean setters, per-route limits, and compatibility constants.
  • Preserved AOSP / CC BY 2.5 attribution paragraphs across the namespace (with a few spots needing alignment to repo conventions).

Reviewed changes

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

Show a summary per file
File Description
docs/xml/Org.Apache.Http.Conn.Params/IConnRoutePNames.xml Documents route parameter-name constants (proxy/route/local address) and adds attribution.
docs/xml/Org.Apache.Http.Conn.Params/IConnPerRoute.xml Documents per-route connection limit lookup API.
docs/xml/Org.Apache.Http.Conn.Params/IConnManagerPNames.xml Documents connection-manager parameter-name constants and adds attribution.
docs/xml/Org.Apache.Http.Conn.Params/IConnConnectionPNames.xml Documents connection parameter-name constants and adds attribution.
docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParams+InterfaceConsts.xml Replaces placeholder summaries for compatibility constants.
docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParams.xml Improves return/value docs and fills in JNI peer member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParamBean.xml Documents bean constructor and setters; updates JNI peer member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnPerRouteBean.xml Documents per-route configuration API and updates JNI peer member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParams+InterfaceConsts.xml Replaces placeholder summaries for compatibility constants.
docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParams.xml Improves returns/param docs and updates JNI peer member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParamBean.xml Documents bean constructor and setters; updates JNI peer member docs.
docs/xml/Org.Apache.Http.Conn.Params/ConnConnectionParamBean.xml Documents bean constructor and setters; updates JNI peer member docs.
Suppressed comments (7)

docs/xml/Org.Apache.Http.Conn.Params/IConnRoutePNames.xml:46

  • This member’s attribution paragraph doesn't follow the repository’s standard AOSP/CC BY 2.5 attribution format (missing the Android Open Source Project site-policies link and using different license title/text). Update it to match the standard template used in other Org.Apache.Http.Conn.Params docs.
          <para>Portions of this page are modifications based on work created and shared by the Android Open Source Project and used under the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons Attribution 2.5 License">Creative Commons Attribution 2.5 License</a></format>.</para>

docs/xml/Org.Apache.Http.Conn.Params/IConnRoutePNames.xml:72

  • This member’s attribution paragraph doesn't follow the repository’s standard AOSP/CC BY 2.5 attribution format (missing the Android Open Source Project site-policies link and using different license title/text). Update it to match the standard template used in other Org.Apache.Http.Conn.Params docs.
          <para>Portions of this page are modifications based on work created and shared by the Android Open Source Project and used under the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons Attribution 2.5 License">Creative Commons Attribution 2.5 License</a></format>.</para>

docs/xml/Org.Apache.Http.Conn.Params/IConnRoutePNames.xml:98

  • This member’s attribution paragraph doesn't follow the repository’s standard AOSP/CC BY 2.5 attribution format (missing the Android Open Source Project site-policies link and using different license title/text). Update it to match the standard template used in other Org.Apache.Http.Conn.Params docs.
          <para>Portions of this page are modifications based on work created and shared by the Android Open Source Project and used under the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons Attribution 2.5 License">Creative Commons Attribution 2.5 License</a></format>.</para>

docs/xml/Org.Apache.Http.Conn.Params/IConnManagerPNames.xml:46

  • This member’s attribution paragraph doesn't follow the repository’s standard AOSP/CC BY 2.5 attribution format (missing the Android Open Source Project site-policies link and using different license title/text). Update it to match the standard template used in other Org.Apache.Http.Conn.Params docs.
          <para>Portions of this page are modifications based on work created and shared by the Android Open Source Project and used under the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons Attribution 2.5 License">Creative Commons Attribution 2.5 License</a></format>.</para>

docs/xml/Org.Apache.Http.Conn.Params/IConnManagerPNames.xml:72

  • This member’s attribution paragraph doesn't follow the repository’s standard AOSP/CC BY 2.5 attribution format (missing the Android Open Source Project site-policies link and using different license title/text). Update it to match the standard template used in other Org.Apache.Http.Conn.Params docs.
          <para>Portions of this page are modifications based on work created and shared by the Android Open Source Project and used under the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons Attribution 2.5 License">Creative Commons Attribution 2.5 License</a></format>.</para>

docs/xml/Org.Apache.Http.Conn.Params/IConnManagerPNames.xml:98

  • This member’s attribution paragraph doesn't follow the repository’s standard AOSP/CC BY 2.5 attribution format (missing the Android Open Source Project site-policies link and using different license title/text). Update it to match the standard template used in other Org.Apache.Http.Conn.Params docs.
          <para>Portions of this page are modifications based on work created and shared by the Android Open Source Project and used under the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons Attribution 2.5 License">Creative Commons Attribution 2.5 License</a></format>.</para>

docs/xml/Org.Apache.Http.Conn.Params/IConnConnectionPNames.xml:46

  • This member’s attribution paragraph doesn't follow the repository’s standard AOSP/CC BY 2.5 attribution format (missing the Android Open Source Project site-policies link and using different license title/text). Update it to match the standard template used elsewhere.
          <para>Portions of this page are modifications based on work created and shared by the Android Open Source Project and used under the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons Attribution 2.5 License">Creative Commons Attribution 2.5 License</a></format>.</para>

💡 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/IConnRoutePNames.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/IConnManagerPNames.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/IConnConnectionPNames.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParams.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnRouteParamBean.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnPerRouteBean.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Conn.Params/ConnManagerParams.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
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
Member Author

Closing as a duplicate of the existing open PR #531 for Org.Apache.Http.Conn.Params; continuing work on #531 to preserve a single namespace owner.

auto-merge was automatically disabled August 15, 2026 16:54

Pull request was closed

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