Skip to content

Document Apache HTTP implementations - #528

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-http-impl-apis
Open

Document Apache HTTP implementations#528
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-http-impl-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Closes #301

Sources

Validation

  • Parsed all 13 changed XML files with System.Xml.XmlDocument.
  • Confirmed no To be added. placeholders remain in Org.Apache.Http.Impl or its namespace XML.
  • Ran git diff --check.

Refs #301

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 XML documentation for the Org.Apache.Http.Impl namespace to replace To be added. placeholders with meaningful summaries/parameter/return descriptions, aligning the generated API docs with the underlying Apache HTTP implementation types exposed in Mono.Android.

Changes:

  • Replaced placeholder summaries across core connection/strategy/factory types in Org.Apache.Http.Impl.
  • Added parameter and return-value documentation for key methods/properties (e.g., socket binding, buffer creation, metrics lookups).
  • Added a namespace-level summary for Org.Apache.Http.Impl.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/xml/Org.Apache.Http.Impl/SocketHttpServerConnection.xml Adds class/member docs for socket-backed HTTP server connections.
docs/xml/Org.Apache.Http.Impl/SocketHttpClientConnection.xml Adds class/member docs for socket-backed HTTP client connections.
docs/xml/Org.Apache.Http.Impl/NoConnectionReuseStrategy.xml Documents the “never reuse” connection reuse strategy (one doc accuracy fix requested).
docs/xml/Org.Apache.Http.Impl/HttpConnectionMetricsImpl.xml Documents connection metrics collection and metric accessors.
docs/xml/Org.Apache.Http.Impl/EnglishReasonPhraseCatalog.xml Documents English HTTP status reason phrase lookup behavior.
docs/xml/Org.Apache.Http.Impl/DefaultHttpServerConnection.xml Documents default server connection implementation details.
docs/xml/Org.Apache.Http.Impl/DefaultHttpClientConnection.xml Documents default client connection implementation details.
docs/xml/Org.Apache.Http.Impl/DefaultHttpResponseFactory.xml Documents default HTTP response creation APIs.
docs/xml/Org.Apache.Http.Impl/DefaultHttpRequestFactory.xml Documents default HTTP request creation APIs.
docs/xml/Org.Apache.Http.Impl/DefaultConnectionReuseStrategy.xml Documents default connection reuse decision logic entry points.
docs/xml/Org.Apache.Http.Impl/AbstractHttpServerConnection.xml Documents base server connection behavior and extensibility points.
docs/xml/Org.Apache.Http.Impl/AbstractHttpClientConnection.xml Documents base client connection behavior and extensibility points.
docs/xml/ns-Org.Apache.Http.Impl.xml Adds a namespace-level summary for Org.Apache.Http.Impl.

💡 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.Impl/NoConnectionReuseStrategy.xml Outdated
Refs #301

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.Impl

2 participants