Document Org.Apache.Http.Conn.Params - #572
Conversation
Closes #274 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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 theOrg.Apache.Http.Conn.ParamsXML 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.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Pull request was closed
Summary
Org.Apache.Http.Conn.Paramsconnection, route, and connection-manager parameter APIs.Closes #274
Sources
Validation
docs/xml/Org.Apache.Http.Conn.Params/*.xmlfiles with PowerShell XML parsing.To be added.has zero matches indocs/xml/Org.Apache.Http.Conn.Params.git diff --checkand verified only 12 scoped XML files changed.