Skip to content

Document HTTP parameter contracts #426

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

Merged
jonathanpeppers merged 2 commits into from
Aug 14, 2026
+31 −36
Merged

Document HTTP parameter contracts #426

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
b78e626
Document HTTP parameter contracts
jonathanpeppers Aug 14, 2026
d6e20f4
Correct HTTP parameter contracts
jonathanpeppers Aug 14, 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
28 changes: 14 additions & 14 deletions docs/xml/Org.Apache.Http.Params/AbstractHttpParams.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,10 @@
<Parameter Name="defaultValue" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="name">the parent name.</param>
<param name="name">parameter name.</param>
<param name="defaultValue">the default value.</param>
<summary>Returns a <see cref="T:Java.Lang.Boolean" /> parameter value with the given name.</summary>
<returns>To be added.</returns>
<summary>Returns the Boolean parameter value with the given name, or the default value when it is not explicitly set.</summary>
<returns>The parameter value, or <paramref name="defaultValue" /> when it is not explicitly set.</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 @@ -207,10 +207,10 @@
<Parameter Name="defaultValue" Type="System.Double" />
</Parameters>
<Docs>
<param name="name">the parent name.</param>
<param name="name">parameter name.</param>
<param name="defaultValue">the default value.</param>
<summary>Returns a <see cref="T:Java.Lang.Double" /> parameter value with the given name.</summary>
<returns>To be added.</returns>
<summary>Returns the Double parameter value with the given name, or the default value when it is not explicitly set.</summary>
<returns>The parameter value, or <paramref name="defaultValue" /> when it is not explicitly set.</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 @@ -244,10 +244,10 @@
<Parameter Name="defaultValue" Type="System.Int32" />
</Parameters>
<Docs>
<param name="name">the parent name.</param>
<param name="name">parameter name.</param>
<param name="defaultValue">the default value.</param>
<summary>Returns an <see cref="T:Java.Lang.Integer" /> parameter value with the given name.</summary>
<returns>To be added.</returns>
<summary>Returns the Integer parameter value with the given name, or the default value when it is not explicitly set.</summary>
<returns>The parameter value, or <paramref name="defaultValue" /> when it is not explicitly set.</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 @@ -281,10 +281,10 @@
<Parameter Name="defaultValue" Type="System.Int64" />
</Parameters>
<Docs>
<param name="name">the parent name.</param>
<param name="name">parameter name.</param>
<param name="defaultValue">the default value.</param>
<summary>Returns a <see cref="T:Java.Lang.Long" /> parameter value with the given name.</summary>
<returns>To be added.</returns>
<summary>Returns the Long parameter value with the given name, or the default value when it is not explicitly set.</summary>
<returns>The parameter value, or <paramref name="defaultValue" /> when it is not explicitly set.</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 @@ -369,7 +369,7 @@
<Docs>
<param name="name">parameter name</param>
<summary>Checks if a boolean parameter is not set or <c>false</c>.</summary>
<returns>To be added.</returns>
<returns><c>true</c> if the parameter is either not set or set to <c>false</c>, <c>false</c> if it is set to <c>true</c>.</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 @@ -404,7 +404,7 @@
<Docs>
<param name="name">parameter name</param>
<summary>Checks if a boolean parameter is set to <c>true</c>.</summary>
<returns>To be added.</returns>
<returns><c>true</c> if the parameter is set to <c>true</c>, <c>false</c> if it is not set or set to <c>false</c>.</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
39 changes: 17 additions & 22 deletions docs/xml/Org.Apache.Http.Params/BasicHttpParams.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@
<Parameters />
<Docs>
<summary>Creates a copy of these parameters.</summary>
<returns>To be added.</returns>
<returns>a new set of parameters holding a copy of the local parameters in this object.</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 @@ -189,10 +189,9 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>
</summary>
<returns>To be added.</returns>
<param name="name">parameter name.</param>
<summary>Obtains the value of the given parameter.</summary>
<returns>an object that represents the value of the parameter, <c>null</c> if the parameter is not set or if it is explicitly set to <c>null</c>.</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 @@ -222,10 +221,9 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>
</summary>
<returns>To be added.</returns>
<param name="name">parameter name</param>
<summary>Checks whether the parameter is set.</summary>
<returns><c>true</c> if the parameter is defined and non-null.</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 @@ -255,10 +253,9 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>
</summary>
<returns>To be added.</returns>
<param name="name">parameter name</param>
<summary>Checks whether the parameter is set in this object.</summary>
<returns><c>true</c> if the parameter is defined and non-null.</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 @@ -326,10 +323,9 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>
</summary>
<returns>To be added.</returns>
<param name="name">parameter name</param>
<summary>Removes the parameter with the specified name.</summary>
<returns><c>true</c> if the parameter existed and was removed; otherwise, <c>false</c>.</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 @@ -360,11 +356,10 @@
<Parameter Name="value" Type="Java.Lang.Object" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="value">To be added.</param>
<summary>
</summary>
<returns>To be added.</returns>
<param name="name">parameter name</param>
<param name="value">parameter value</param>
<summary>Assigns the value to the parameter with the given name.</summary>
<returns>This parameter collection.</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