Skip to content

Document Org.Apache.Http.Impl.Entity #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanpeppers wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document Org.Apache.Http.Impl.Entity #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e44ce0
Document Apache HTTP entity implementation
jonathanpeppers Aug 15, 2026
465b16b
Use HTTP transfer encoding terminology
jonathanpeppers Aug 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/xml/Org.Apache.Http.Impl.Entity/EntityDeserializer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Deserializes an HTTP message body into an HTTP entity by using a content-length strategy.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -57,8 +57,8 @@
<Parameter Name="lenStrategy" Type="Org.Apache.Http.Entity.IContentLengthStrategy" />
</Parameters>
<Docs>
<param name="lenStrategy">To be added.</param>
<summary>To be added.</summary>
<param name="lenStrategy">The strategy used to determine the message body length.</param>
<summary>Initializes an entity deserializer that uses the specified content-length strategy.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -111,10 +111,10 @@
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
</Parameters>
<Docs>
<param name="inbuffer">To be added.</param>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="inbuffer">The buffer from which to read the entity data.</param>
<param name="message">The HTTP message that contains the entity headers.</param>
<summary>Deserializes the entity in an HTTP message from an input buffer.</summary>
<returns>The entity deserialized from the message and input buffer.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -144,10 +144,10 @@
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
</Parameters>
<Docs>
<param name="inbuffer">To be added.</param>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="inbuffer">The buffer from which to read the entity data.</param>
<param name="message">The HTTP message that contains the entity headers.</param>
<summary>Creates a basic HTTP entity from an HTTP message and its input buffer.</summary>
<returns>The basic HTTP entity deserialized from the message and input buffer.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
22 changes: 11 additions & 11 deletions docs/xml/Org.Apache.Http.Impl.Entity/EntitySerializer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Serializes an HTTP entity to an HTTP message by using a content-length strategy.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -57,8 +57,8 @@
<Parameter Name="lenStrategy" Type="Org.Apache.Http.Entity.IContentLengthStrategy" />
</Parameters>
<Docs>
<param name="lenStrategy">To be added.</param>
<summary>To be added.</summary>
<param name="lenStrategy">The strategy used to determine the message body length.</param>
<summary>Initializes an entity serializer that uses the specified content-length strategy.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -111,10 +111,10 @@
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
</Parameters>
<Docs>
<param name="outbuffer">To be added.</param>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="outbuffer">The buffer to which entity data is written.</param>
<param name="message">The HTTP message that contains the entity headers.</param>
<summary>Creates the output stream used to serialize an HTTP entity.</summary>
<returns>The output stream to which the entity data is written.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -176,10 +176,10 @@
<Parameter Name="entity" Type="Org.Apache.Http.IHttpEntity" />
</Parameters>
<Docs>
<param name="outbuffer">To be added.</param>
<param name="message">To be added.</param>
<param name="entity">To be added.</param>
<summary>To be added.</summary>
<param name="outbuffer">The buffer to which entity data is written.</param>
<param name="message">The HTTP message that contains the entity headers.</param>
<param name="entity">The HTTP entity to serialize.</param>
<summary>Serializes an HTTP entity to an output buffer.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
6 changes: 3 additions & 3 deletions docs/xml/Org.Apache.Http.Impl.Entity/LaxContentLengthStrategy+InterfaceConsts.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Defines content-length sentinel values used by this strategy.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -39,7 +39,7 @@
</ReturnValue>
<MemberValue>-2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Indicates that the message uses chunked transfer encoding.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -66,7 +66,7 @@
</ReturnValue>
<MemberValue>-1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Indicates that the message uses identity transfer encoding.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
10 changes: 5 additions & 5 deletions docs/xml/Org.Apache.Http.Impl.Entity/LaxContentLengthStrategy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Determines an HTTP message body length while tolerating malformed content-length headers and unsupported transfer encodings.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -63,7 +63,7 @@
</Attributes>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:Org.Apache.Http.Impl.Entity.LaxContentLengthStrategy" /> class.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -118,9 +118,9 @@
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="message">The HTTP message whose body length is determined.</param>
<summary>Determines the body length of an HTTP message using lax transfer rules.</summary>
<returns>The body length, or a sentinel value that indicates chunked or identity transfer encoding.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
6 changes: 3 additions & 3 deletions docs/xml/Org.Apache.Http.Impl.Entity/StrictContentLengthStrategy+InterfaceConsts.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Defines content-length sentinel values used by this strategy.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -39,7 +39,7 @@
</ReturnValue>
<MemberValue>-2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Indicates that the message uses chunked transfer encoding.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -66,7 +66,7 @@
</ReturnValue>
<MemberValue>-1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Indicates that the message uses identity transfer encoding.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
10 changes: 5 additions & 5 deletions docs/xml/Org.Apache.Http.Impl.Entity/StrictContentLengthStrategy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Determines an HTTP message body length by strictly applying HTTP transfer rules.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -63,7 +63,7 @@
</Attributes>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:Org.Apache.Http.Impl.Entity.StrictContentLengthStrategy" /> class.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -118,9 +118,9 @@
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="message">The HTTP message whose body length is determined.</param>
<summary>Determines the body length of an HTTP message using strict transfer rules.</summary>
<returns>The body length, or a sentinel value that indicates chunked or identity transfer encoding.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
2 changes: 1 addition & 1 deletion docs/xml/ns-Org.Apache.Http.Impl.Entity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Namespace Name="Org.Apache.Http.Impl.Entity">
<Docs>
<summary>To be added.</summary>
<summary>Provides implementations for serializing and deserializing HTTP message entities.</summary>
<remarks />
</Docs>
</Namespace>