Skip to content

Commit 0670f77

Browse files
jonathanpeppersCopilot
jonathanpeppers
and
Copilot
authored
Document Org.Apache.Http.Impl.Entity (#525)
* Document Apache HTTP entity implementation Refs #258 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Use HTTP transfer encoding terminology Refs #258 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 5361dbb commit 0670f77

7 files changed

Lines changed: 39 additions & 39 deletions

‎docs/xml/Org.Apache.Http.Impl.Entity/EntityDeserializer.xml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
</Attribute>
2727
</Attributes>
2828
<Docs>
29-
<summary>To be added.</summary>
29+
<summary>Deserializes an HTTP message body into an HTTP entity by using a content-length strategy.</summary>
3030
<remarks>
3131
<para>
3232
<format type="text/html">
@@ -57,8 +57,8 @@
5757
<Parameter Name="lenStrategy" Type="Org.Apache.Http.Entity.IContentLengthStrategy" />
5858
</Parameters>
5959
<Docs>
60-
<param name="lenStrategy">To be added.</param>
61-
<summary>To be added.</summary>
60+
<param name="lenStrategy">The strategy used to determine the message body length.</param>
61+
<summary>Initializes an entity deserializer that uses the specified content-length strategy.</summary>
6262
<remarks>
6363
<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>
6464
</remarks>
@@ -111,10 +111,10 @@
111111
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
112112
</Parameters>
113113
<Docs>
114-
<param name="inbuffer">To be added.</param>
115-
<param name="message">To be added.</param>
116-
<summary>To be added.</summary>
117-
<returns>To be added.</returns>
114+
<param name="inbuffer">The buffer from which to read the entity data.</param>
115+
<param name="message">The HTTP message that contains the entity headers.</param>
116+
<summary>Deserializes the entity in an HTTP message from an input buffer.</summary>
117+
<returns>The entity deserialized from the message and input buffer.</returns>
118118
<remarks>
119119
<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>
120120
</remarks>
@@ -144,10 +144,10 @@
144144
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
145145
</Parameters>
146146
<Docs>
147-
<param name="inbuffer">To be added.</param>
148-
<param name="message">To be added.</param>
149-
<summary>To be added.</summary>
150-
<returns>To be added.</returns>
147+
<param name="inbuffer">The buffer from which to read the entity data.</param>
148+
<param name="message">The HTTP message that contains the entity headers.</param>
149+
<summary>Creates a basic HTTP entity from an HTTP message and its input buffer.</summary>
150+
<returns>The basic HTTP entity deserialized from the message and input buffer.</returns>
151151
<remarks>
152152
<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>
153153
</remarks>

‎docs/xml/Org.Apache.Http.Impl.Entity/EntitySerializer.xml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
</Attribute>
2727
</Attributes>
2828
<Docs>
29-
<summary>To be added.</summary>
29+
<summary>Serializes an HTTP entity to an HTTP message by using a content-length strategy.</summary>
3030
<remarks>
3131
<para>
3232
<format type="text/html">
@@ -57,8 +57,8 @@
5757
<Parameter Name="lenStrategy" Type="Org.Apache.Http.Entity.IContentLengthStrategy" />
5858
</Parameters>
5959
<Docs>
60-
<param name="lenStrategy">To be added.</param>
61-
<summary>To be added.</summary>
60+
<param name="lenStrategy">The strategy used to determine the message body length.</param>
61+
<summary>Initializes an entity serializer that uses the specified content-length strategy.</summary>
6262
<remarks>
6363
<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>
6464
</remarks>
@@ -111,10 +111,10 @@
111111
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
112112
</Parameters>
113113
<Docs>
114-
<param name="outbuffer">To be added.</param>
115-
<param name="message">To be added.</param>
116-
<summary>To be added.</summary>
117-
<returns>To be added.</returns>
114+
<param name="outbuffer">The buffer to which entity data is written.</param>
115+
<param name="message">The HTTP message that contains the entity headers.</param>
116+
<summary>Creates the output stream used to serialize an HTTP entity.</summary>
117+
<returns>The output stream to which the entity data is written.</returns>
118118
<remarks>
119119
<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>
120120
</remarks>
@@ -176,10 +176,10 @@
176176
<Parameter Name="entity" Type="Org.Apache.Http.IHttpEntity" />
177177
</Parameters>
178178
<Docs>
179-
<param name="outbuffer">To be added.</param>
180-
<param name="message">To be added.</param>
181-
<param name="entity">To be added.</param>
182-
<summary>To be added.</summary>
179+
<param name="outbuffer">The buffer to which entity data is written.</param>
180+
<param name="message">The HTTP message that contains the entity headers.</param>
181+
<param name="entity">The HTTP entity to serialize.</param>
182+
<summary>Serializes an HTTP entity to an output buffer.</summary>
183183
<remarks>
184184
<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>
185185
</remarks>

‎docs/xml/Org.Apache.Http.Impl.Entity/LaxContentLengthStrategy+InterfaceConsts.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</Base>
1313
<Interfaces />
1414
<Docs>
15-
<summary>To be added.</summary>
15+
<summary>Defines content-length sentinel values used by this strategy.</summary>
1616
<remarks>
1717
<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>
1818
</remarks>
@@ -39,7 +39,7 @@
3939
</ReturnValue>
4040
<MemberValue>-2</MemberValue>
4141
<Docs>
42-
<summary>To be added.</summary>
42+
<summary>Indicates that the message uses chunked transfer encoding.</summary>
4343
<remarks>
4444
<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>
4545
</remarks>
@@ -66,7 +66,7 @@
6666
</ReturnValue>
6767
<MemberValue>-1</MemberValue>
6868
<Docs>
69-
<summary>To be added.</summary>
69+
<summary>Indicates that the message uses identity transfer encoding.</summary>
7070
<remarks>
7171
<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>
7272
</remarks>

‎docs/xml/Org.Apache.Http.Impl.Entity/LaxContentLengthStrategy.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
</Attribute>
3636
</Attributes>
3737
<Docs>
38-
<summary>To be added.</summary>
38+
<summary>Determines an HTTP message body length while tolerating malformed content-length headers and unsupported transfer encodings.</summary>
3939
<remarks>
4040
<para>
4141
<format type="text/html">
@@ -63,7 +63,7 @@
6363
</Attributes>
6464
<Parameters />
6565
<Docs>
66-
<summary>To be added.</summary>
66+
<summary>Initializes a new instance of the <see cref="T:Org.Apache.Http.Impl.Entity.LaxContentLengthStrategy" /> class.</summary>
6767
<remarks>
6868
<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>
6969
</remarks>
@@ -118,9 +118,9 @@
118118
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
119119
</Parameters>
120120
<Docs>
121-
<param name="message">To be added.</param>
122-
<summary>To be added.</summary>
123-
<returns>To be added.</returns>
121+
<param name="message">The HTTP message whose body length is determined.</param>
122+
<summary>Determines the body length of an HTTP message using lax transfer rules.</summary>
123+
<returns>The body length, or a sentinel value that indicates chunked or identity transfer encoding.</returns>
124124
<remarks>
125125
<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>
126126
</remarks>

‎docs/xml/Org.Apache.Http.Impl.Entity/StrictContentLengthStrategy+InterfaceConsts.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</Base>
1313
<Interfaces />
1414
<Docs>
15-
<summary>To be added.</summary>
15+
<summary>Defines content-length sentinel values used by this strategy.</summary>
1616
<remarks>
1717
<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>
1818
</remarks>
@@ -39,7 +39,7 @@
3939
</ReturnValue>
4040
<MemberValue>-2</MemberValue>
4141
<Docs>
42-
<summary>To be added.</summary>
42+
<summary>Indicates that the message uses chunked transfer encoding.</summary>
4343
<remarks>
4444
<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>
4545
</remarks>
@@ -66,7 +66,7 @@
6666
</ReturnValue>
6767
<MemberValue>-1</MemberValue>
6868
<Docs>
69-
<summary>To be added.</summary>
69+
<summary>Indicates that the message uses identity transfer encoding.</summary>
7070
<remarks>
7171
<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>
7272
</remarks>

‎docs/xml/Org.Apache.Http.Impl.Entity/StrictContentLengthStrategy.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
</Attribute>
3636
</Attributes>
3737
<Docs>
38-
<summary>To be added.</summary>
38+
<summary>Determines an HTTP message body length by strictly applying HTTP transfer rules.</summary>
3939
<remarks>
4040
<para>
4141
<format type="text/html">
@@ -63,7 +63,7 @@
6363
</Attributes>
6464
<Parameters />
6565
<Docs>
66-
<summary>To be added.</summary>
66+
<summary>Initializes a new instance of the <see cref="T:Org.Apache.Http.Impl.Entity.StrictContentLengthStrategy" /> class.</summary>
6767
<remarks>
6868
<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>
6969
</remarks>
@@ -118,9 +118,9 @@
118118
<Parameter Name="message" Type="Org.Apache.Http.IHttpMessage" />
119119
</Parameters>
120120
<Docs>
121-
<param name="message">To be added.</param>
122-
<summary>To be added.</summary>
123-
<returns>To be added.</returns>
121+
<param name="message">The HTTP message whose body length is determined.</param>
122+
<summary>Determines the body length of an HTTP message using strict transfer rules.</summary>
123+
<returns>The body length, or a sentinel value that indicates chunked or identity transfer encoding.</returns>
124124
<remarks>
125125
<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>
126126
</remarks>

‎docs/xml/ns-Org.Apache.Http.Impl.Entity.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Org.Apache.Http.Impl.Entity">
22
<Docs>
3-
<summary>To be added.</summary>
3+
<summary>Provides implementations for serializing and deserializing HTTP message entities.</summary>
44
<remarks />
55
</Docs>
66
</Namespace>

0 commit comments

Comments
 (0)