8000 missing doc for HttpRequestOptions by pavelsavara · Pull Request #7129 · dotnet/dotnet-api-docs · GitHub
[go: up one dir, main page]
Skip to content

missing doc for HttpRequestOptions #7129

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
merged 2 commits into from
Sep 10, 2021
Merged

missing doc for HttpRequestOptions #7129

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
908a206
missing doc for HttpRequestOptions, HttpRequestOptionsKey and HttpReq…
pavelsavara Sep 9, 2021
a265def
Apply suggestions from code review
lewing Sep 10, 2021
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
2 changes: 1 addition & 1 deletion xml/System.Net.Http/HttpRequestMessage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@
<ReturnType>System.Net.Http.HttpRequestOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the collection of options to configure the HTTP request.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
41 changes: 25 additions & 16 deletions xml/System.Net.Http/HttpRequestOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<summary>Represents a collection of options for an HTTP request.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -55,7 +55,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the HttpRequestOptions class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -83,10 +83,10 @@
<Parameter Name="value" Type="TValue" />
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<typeparam name="TValue">The type of the HTTP value as defined by <paramref name="key" />.</typeparam>
<param name="key">The strongly typed key for the HTTP request option.</param>
<param name="value">The value of the HTTP request option.</param>
<summary>Sets the value of a specified HTTP request option.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -545,11 +545,20 @@ This member is an explicit interface member implementation. It can be used only
<Parameter Name="value" Type="System.Object" RefType="out" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="key">The key of the value to get.</param>
<param name="value">When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the <paramref name="value" /> parameter. This parameter is passed uninitialized.</param>
<summary>Gets the value associated with the specified key.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Collections.Generic.Dictionary`2" /> contains an element with the specified key; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Net.Http.HttpRequestOptions> instance is cast to an <xref:System.Collections.Generic.IDictionary%602> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;.Values">
Expand Down Expand Up @@ -684,11 +693,11 @@ This member is an explicit interface member implementation. It can be used only
</Parameter>
</Parameters>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TValue">The type of the HTTP value as defined by <paramref name="key" />.</typeparam>
<param name="key">The strongly typed key to get the value of an HTTP request option.</param>
<param name="value">When this method returns, contains the value of the specified HTTP request option.</param>
<summary>Gets the value of a specified HTTP request option.</summary>
<returns><see langword="true" /> if the collection contains an element with the specified key; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System.Net.Http/HttpRequestOptionsKey`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
</Attribute>
</Attributes>
<Docs>
<typeparam name="TValue">To be added.</typeparam>
<summary>To be added.</summary>
<typeparam name="TValue">The type of the value of the option.</typeparam>
<summary>Represents a key in the options collection for an HTTP request.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -46,8 +46,8 @@
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<summary>To be added.</summary>
<param name="key">Name of the HTTP request option.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestOptionsKey`1" /> class using the specified key name.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -68,7 +68,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the name of the option.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
0