Document Org.Apache.Http.Impl.Entity - #525
Open
jonathanpeppers wants to merge 2 commits into
Open
Conversation
Refs #258 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and
a lite review from Copilot
August 15, 2026 05:01
jonathanpeppers
enabled auto-merge (squash)
August 15, 2026 05:01
There was a problem hiding this comment.
Pull request overview
This PR replaces “To be added.” placeholders with XML documentation for key public APIs in the Org.Apache.Http.Impl.Entity namespace, improving the generated API docs without changing any binding members.
Changes:
- Added class/member summaries and parameter/return documentation for entity serialization/deserialization APIs (
EntitySerializer,EntityDeserializer). - Documented content-length strategy behaviors for
LaxContentLengthStrategyandStrictContentLengthStrategy. - Documented namespace summary and sentinel constants in the
InterfaceConstscompanion XML files.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/xml/Org.Apache.Http.Impl.Entity/StrictContentLengthStrategy+InterfaceConsts.xml | Adds summaries for sentinel constant container and its fields. |
| docs/xml/Org.Apache.Http.Impl.Entity/StrictContentLengthStrategy.xml | Documents strategy purpose, constructor, and DetermineLength API. |
| docs/xml/Org.Apache.Http.Impl.Entity/LaxContentLengthStrategy+InterfaceConsts.xml | Adds summaries for sentinel constant container and its fields. |
| docs/xml/Org.Apache.Http.Impl.Entity/LaxContentLengthStrategy.xml | Documents strategy purpose, constructor, and DetermineLength API. |
| docs/xml/Org.Apache.Http.Impl.Entity/EntitySerializer.xml | Documents serializer class plus key serialization methods/parameters. |
| docs/xml/Org.Apache.Http.Impl.Entity/EntityDeserializer.xml | Documents deserializer class plus key deserialization methods/parameters. |
| docs/xml/ns-Org.Apache.Http.Impl.Entity.xml | Adds a namespace-level summary describing the package’s purpose. |
Suppressed comments (3)
docs/xml/Org.Apache.Http.Impl.Entity/LaxContentLengthStrategy.xml:123
- HTTP commonly refers to "chunked"/"identity" as transfer encodings (see e.g. docs/xml/Java.Net/HttpURLConnection.xml:2441). Consider using "transfer encoding" in this return description for consistency and clarity.
<returns>The body length, or a sentinel value that indicates chunked or identity transfer coding.</returns>
docs/xml/Org.Apache.Http.Impl.Entity/LaxContentLengthStrategy+InterfaceConsts.xml:69
- For consistency with common HTTP terminology and existing docs (e.g. docs/xml/Java.Net/HttpURLConnection.xml:2441), consider using "identity transfer encoding" here instead of "transfer coding".
<summary>Indicates that the message uses identity transfer coding.</summary>
docs/xml/Org.Apache.Http.Impl.Entity/StrictContentLengthStrategy+InterfaceConsts.xml:69
- For consistency with common HTTP terminology and existing docs (e.g. docs/xml/Java.Net/HttpURLConnection.xml:2441), consider using "identity transfer encoding" here instead of "transfer coding".
<summary>Indicates that the message uses identity transfer coding.</summary>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Refs #258 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Member
Author
|
@dalexsoto review |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Org.Apache.Http.Impl.Entity.Refs #258
Sources
Validation
git diff --check.