Document HTTP parameter contracts

[jonathanpeppers]

Refs #283

Sources

• Apache HttpComponents Core 4.0 AbstractHttpParams.java: https://raw.githubusercontent.com/apache/httpcomponents-core/rel/v4.0/module-main/src/main/java/org/apache/http/params/AbstractHttpParams.java
• Apache HttpComponents Core 4.0 BasicHttpParams.java: https://raw.githubusercontent.com/apache/httpcomponents-core/rel/v4.0/module-main/src/main/java/org/apache/http/params/BasicHttpParams.java
• Apache HttpComponents Core 4.0 HttpParams.java: https://raw.githubusercontent.com/apache/httpcomponents-core/rel/v4.0/module-main/src/main/java/org/apache/http/params/HttpParams.java

Validation

• Parsed both modified XML files with PowerShell's XML parser.
• Ran git diff --check.
• Verified CRLF line endings with no bare LF in both modified files.

[Copilot]

Pull request overview

This PR updates the generated XML documentation for Org.Apache.Http.Params to replace “To be added.” placeholders with concrete parameter/return contracts, aligning the docs more closely with the upstream Apache HttpComponents semantics.

Changes:

• Updated multiple member <Docs> blocks to provide real <summary>, <param>, and <returns> content for key parameter APIs.
• Improved return/value descriptions for several parameter lookup helpers (e.g., boolean true/false semantics).
• Reduced placeholder text in the namespace docs to address Issue #283.

Reviewed changes

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

File	Description
docs/xml/Org.Apache.Http.Params/BasicHttpParams.xml	Fills in docs for common parameter operations (copy/get/is-set/remove/set).
docs/xml/Org.Apache.Http.Params/AbstractHttpParams.xml	Improves documentation for typed parameter getters and boolean helper semantics.

Suppressed comments (4)

docs/xml/Org.Apache.Http.Params/BasicHttpParams.xml:362

• The method summary/params were filled in, but the return contract is still left as "To be added.". For HttpParams.setParameter this is a fluent API that returns the updated parameter set (typically this instance).

        <summary>Assigns the value to the parameter with the given name.</summary>
        <returns>To be added.</returns>

docs/xml/Org.Apache.Http.Params/AbstractHttpParams.xml:250

• The return type is int, but the docs describe returning Java.Lang.Integer and don't mention the defaultValue behavior. Also, "parent name" should be "parameter name".

        <param name="name">the parent name.</param>
        <param name="defaultValue">the default value.</param>
        <summary>Returns an <see cref="T:Java.Lang.Integer" /> parameter value with the given name.</summary>
        <returns>an <see cref="T:Java.Lang.Integer" /> that represents the value of the parameter.</returns>

docs/xml/Org.Apache.Http.Params/AbstractHttpParams.xml:213

• The return type is double, but the docs describe returning Java.Lang.Double and don't mention the defaultValue behavior. Also, "parent name" should be "parameter name".

        <param name="name">the parent name.</param>
        <param name="defaultValue">the default value.</param>
        <summary>Returns a <see cref="T:Java.Lang.Double" /> parameter value with the given name.</summary>
        <returns>a <see cref="T:Java.Lang.Double" /> that represents the value of the parameter.</returns>

docs/xml/Org.Apache.Http.Params/AbstractHttpParams.xml:287

• The return type is long, but the docs describe returning Java.Lang.Long and don't mention the defaultValue behavior. Also, "parent name" should be "parameter name".

        <param name="name">the parent name.</param>
        <param name="defaultValue">the default value.</param>
        <summary>Returns a <see cref="T:Java.Lang.Long" /> parameter value with the given name.</summary>
        <returns>a <see cref="T:Java.Lang.Long" /> that represents the value of the parameter.</returns>

---

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