Skip to content

Add Apache HTTP Message XML docs - #429

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-apache-http-message
Open

Add Apache HTTP Message XML docs#429
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-apache-http-message

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Sources

Validation

  • Parsed all 24 docs/xml/Org.Apache.Http.Message/*.xml documents as XML.
  • Confirmed CRLF line endings throughout the scoped XML files.
  • Ran git diff --check and confirmed the precise diff is limited to 22 files in docs/xml/Org.Apache.Http.Message/.
  • Recounted 117 To be added. placeholders that lack safe authoritative coverage; this PR replaces 205 source-backed placeholders and leaves issue Add XML documentation for Org.Apache.Http.Message #298 open.

Refs #298

Refs #298

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

Adds/updates API XML documentation for the Org.Apache.Http.Message namespace, primarily replacing To be added. placeholders with source-backed summaries, parameter descriptions, return values, and property values to improve generated reference docs.

Changes:

  • Replaces placeholder <returns>, <value>, and <param> text across Org.Apache.Http.Message XML docs.
  • Improves boolean return descriptions to explicitly document true/false outcomes and nullability where applicable.
  • Updates parser/formatter and header-iteration related docs to better describe inputs/outputs.

Reviewed changes

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

Show a summary per file
File Description
docs/xml/Org.Apache.Http.Message/AbstractHttpMessage.xml Replaces placeholder returns/values for header accessors and protocol compatibility docs.
docs/xml/Org.Apache.Http.Message/BasicHeader.xml Fills constructor params, parsed-elements return, and name/value property docs.
docs/xml/Org.Apache.Http.Message/BasicHeaderElement.xml Adds constructor param docs and clarifies parameter/value accessors and null returns.
docs/xml/Org.Apache.Http.Message/BasicHeaderElementIterator.xml Replaces placeholders for iteration state/value and next-element return.
docs/xml/Org.Apache.Http.Message/BasicHeaderIterator.xml Adds param/value/return docs for header iteration and filtering behavior.
docs/xml/Org.Apache.Http.Message/BasicHeaderValueFormatter.xml Replaces placeholders for default instance/value and formatting/length-estimation APIs.
docs/xml/Org.Apache.Http.Message/BasicHeaderValueParser.xml Replaces placeholders for default instance/value and parsing APIs (elements, NV pairs, parameters).
docs/xml/Org.Apache.Http.Message/BasicHttpEntityEnclosingRequest.xml Documents entity property and expect-continue handshake boolean return.
docs/xml/Org.Apache.Http.Message/BasicHttpRequest.xml Documents protocol compatibility and request-line properties.
docs/xml/Org.Apache.Http.Message/BasicHttpResponse.xml Documents constructors, entity/locale/status accessors, and reason-phrase lookup return.
docs/xml/Org.Apache.Http.Message/BasicLineFormatter.xml Documents formatting APIs, default instance, and buffer acquisition return values.
docs/xml/Org.Apache.Http.Message/BasicLineParser.xml Documents parser ctor param and return values for parsing/instantiation helpers.
docs/xml/Org.Apache.Http.Message/BasicListHeaderIterator.xml Documents list iteration/filtering params, state properties, and next-header returns.
docs/xml/Org.Apache.Http.Message/BasicNameValuePair.xml Updates ctor/Name/Value docs; includes a problematic change to JniPeerMembers docs.
docs/xml/Org.Apache.Http.Message/BasicStatusLine.xml Documents ctor params and property values for version/reason/status.
docs/xml/Org.Apache.Http.Message/BasicTokenIterator.xml Replaces placeholders for token iteration internals and token-character classification helpers.
docs/xml/Org.Apache.Http.Message/BufferedHeader.xml Documents buffer ctor param and property value descriptions (name/value offsets).
docs/xml/Org.Apache.Http.Message/HeaderGroup.xml Documents presence checks, header retrieval returns (including null cases), and iterators.
docs/xml/Org.Apache.Http.Message/IHeaderValueFormatter.xml Documents formatter return buffers for elements, NV pairs, and parameter formatting.
docs/xml/Org.Apache.Http.Message/IHeaderValueParser.xml Documents parse inputs and return types for elements/elements/NV pairs/parameter lists.
docs/xml/Org.Apache.Http.Message/ILineFormatter.xml Documents return buffers for formatting protocol version/header/request/status lines.
docs/xml/Org.Apache.Http.Message/ILineParser.xml Documents return values for protocol/version/header/request/status parsing APIs.

💡 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.Message/BasicNameValuePair.xml Outdated
Comment thread docs/xml/Org.Apache.Http.Message/BasicTokenIterator.xml Outdated
Refs #298

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

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.

2 participants