Document HTTP connection routing APIs

[jonathanpeppers]

Refs #284

Sources

• Android 6.0 Apache HTTP client removal notice
• Apache HttpClient 4.2.5 source archive
• AOSP Apache HTTP routing sources

Validation

• Parsed every XML file in docs/xml/Org.Apache.Http.Conn.Routing/ with PowerShell XML parsing.
• Confirmed CRLF endings for every scoped XML file.
• Confirmed no scoped To be added or empty documentation placeholders remain.
• Ran git diff --check.

[Copilot]

Pull request overview

This PR updates the generated XML reference documentation for Org.Apache.Http.Conn.Routing by replacing remaining “To be added.” placeholders with meaningful API documentation, aligning with issue #284’s goal of fully documenting the routing APIs.

Changes:

• Replaced placeholder <param>, <returns>, and <value> documentation across routing interfaces/types.
• Added/standardized routing-step constant documentation for route directors.
• Filled in missing or incomplete summaries for key routing types and members.

Reviewed changes

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

Show a summary per file

File	Description
docs/xml/Org.Apache.Http.Conn.Routing/RouteTracker.xml	Documents constructors, return values, and properties for tracking established routes.
docs/xml/Org.Apache.Http.Conn.Routing/RouteInfoTunnelType.xml	Documents tunnel type enum values and standard enum helpers (e.g., valueOf, values).
docs/xml/Org.Apache.Http.Conn.Routing/RouteInfoLayerType.xml	Documents layer type enum values and standard enum helpers (e.g., valueOf, values).
docs/xml/Org.Apache.Http.Conn.Routing/IRouteInfo.xml	Documents hop count and route attribute properties for the route info contract.
docs/xml/Org.Apache.Http.Conn.Routing/IHttpRoutePlanner.xml	Documents the route-planning API return value.
docs/xml/Org.Apache.Http.Conn.Routing/IHttpRouteDirector.xml	Documents route-director constants and return value semantics for NextStep.
docs/xml/Org.Apache.Http.Conn.Routing/HttpRoute.xml	Documents constructors and route attribute members for describing HTTP routes.
docs/xml/Org.Apache.Http.Conn.Routing/BasicRouteDirector+InterfaceConsts.xml	Documents step constants used to establish an HTTP route.
docs/xml/Org.Apache.Http.Conn.Routing/BasicRouteDirector.xml	Documents the basic route director’s constructor and step-determination methods.

Suppressed comments (6)

docs/xml/Org.Apache.Http.Conn.Routing/IHttpRouteDirector.xml:91

• This file uses a self-closing tag, which appears inconsistent with other XML docs in the repo (typically when empty). Use an explicit open/close tag for consistency with existing formatting.

        <remarks />

docs/xml/Org.Apache.Http.Conn.Routing/IHttpRouteDirector.xml:116

• This file uses a self-closing tag, which appears inconsistent with other XML docs in the repo (typically when empty). Use an explicit open/close tag for consistency with existing formatting.

        <remarks />

docs/xml/Org.Apache.Http.Conn.Routing/IHttpRouteDirector.xml:141

• This file uses a self-closing tag, which appears inconsistent with other XML docs in the repo (typically when empty). Use an explicit open/close tag for consistency with existing formatting.

        <remarks />

docs/xml/Org.Apache.Http.Conn.Routing/IHttpRouteDirector.xml:201

• This file uses a self-closing tag, which appears inconsistent with other XML docs in the repo (typically when empty). Use an explicit open/close tag for consistency with existing formatting.

        <remarks />

docs/xml/Org.Apache.Http.Conn.Routing/IHttpRouteDirector.xml:226

• This file uses a self-closing tag, which appears inconsistent with other XML docs in the repo (typically when empty). Use an explicit open/close tag for consistency with existing formatting.

        <remarks />

docs/xml/Org.Apache.Http.Conn.Routing/IHttpRouteDirector.xml:251

• This file uses a self-closing tag, which appears inconsistent with other XML docs in the repo (typically when empty). Use an explicit open/close tag for consistency with existing formatting.

        <remarks />

---

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