Skip to content

Commit 753c32e

Browse files
authored
Merge pull request dotnet#7129 from pavelsavara/HttpRequestOptions
missing doc for HttpRequestOptions
2 parents bda5a97 + a265def commit 753c32e

File tree

3 files changed

+31
-22
lines changed

3 files changed

+31
-22
lines changed

xml/System.Net.Http/HttpRequestMessage.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@
391391
<ReturnType>System.Net.Http.HttpRequestOptions</ReturnType>
392392
</ReturnValue>
393393
<Docs>
394-
<summary>To be added.</summary>
394+
<summary>Gets the collection of options to configure the HTTP request.</summary>
395395
<value>To be added.</value>
396396
<remarks>To be added.</remarks>
397397
</Docs>

xml/System.Net.Http/HttpRequestOptions.xml

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</Interface>
3838
</Interfaces>
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Represents a collection of options for an HTTP request.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
<Members>
@@ -55,7 +55,7 @@
5555
</AssemblyInfo>
5656
<Parameters />
5757
<Docs>
58-
<summary>To be added.</summary>
58+
<summary>Initializes a new instance of the HttpRequestOptions class.</summary>
5959
<remarks>To be added.</remarks>
6060
</Docs>
6161
</Member>
@@ -83,10 +83,10 @@
8383
<Parameter Name="value" Type="TValue" />
8484
</Parameters>
8585
<Docs>
86-
<typeparam name="TValue">To be added.</typeparam>
87-
<param name="key">To be added.</param>
88-
<param name="value">To be added.</param>
89-
<summary>To be added.</summary>
86+
<typeparam name="TValue">The type of the HTTP value as defined by <paramref name="key" />.</typeparam>
87+
<param name="key">The strongly typed key for the HTTP request option.</param>
88+
<param name="value">The value of the HTTP request option.</param>
89+
<summary>Sets the value of a specified HTTP request option.</summary>
9090
<remarks>To be added.</remarks>
9191
</Docs>
9292
</Member>
@@ -545,11 +545,20 @@ This member is an explicit interface member implementation. It can be used only
545545
<Parameter Name="value" Type="System.Object" RefType="out" />
546546
</Parameters>
547547
<Docs>
548-
<param name="key">To be added.</param>
549-
<param name="value">To be added.</param>
550-
<summary>To be added.</summary>
551-
<returns>To be added.</returns>
552-
<remarks>To be added.</remarks>
548+
<param name="key">The key of the value to get.</param>
549+
<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>
550+
<summary>Gets the value associated with the specified key.</summary>
551+
<returns>
552+
<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>
553+
<remarks>
554+
<format type="text/markdown"><![CDATA[
555+
556+
## Remarks
557+
558+
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.
559+
560+
]]></format>
561+
</remarks>
553562
</Docs>
554563
</Member>
555564
<Member MemberName="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;.Values">
@@ -684,11 +693,11 @@ This member is an explicit interface member implementation. It can be used only
684693
</Parameter>
685694
</Parameters>
686695
<Docs>
687-
<typeparam name="TValue">To be added.</typeparam>
688-
<param name="key">To be added.</param>
689-
<param name="value">To be added.</param>
690-
<summary>To be added.</summary>
691-
<returns>To be added.</returns>
696+
<typeparam name="TValue">The type of the HTTP value as defined by <paramref name="key" />.</typeparam>
697+
<param name="key">The strongly typed key to get the value of an HTTP request option.</param>
698+
<param name="value">When this method returns, contains the value of the specified HTTP request option.</param>
699+
<summary>Gets the value of a specified HTTP request option.</summary>
700+
<returns><see langword="true" /> if the collection contains an element with the specified key; otherwise, <see langword="false" />.</returns>
692701
<remarks>To be added.</remarks>
693702
</Docs>
694703
</Member>

xml/System.Net.Http/HttpRequestOptionsKey`1.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<typeparam name="TValue">To be added.</typeparam>
28-
<summary>To be added.</summary>
27+
<typeparam name="TValue">The type of the value of the option.</typeparam>
28+
<summary>Represents a key in the options collection for an HTTP request.</summary>
2929
<remarks>To be added.</remarks>
3030
</Docs>
3131
<Members>
@@ -46,8 +46,8 @@
4646
<Parameter Name="key" Type="System.String" />
4747
</Parameters>
4848
<Docs>
49-
<param name="key">To be added.</param>
50-
<summary>To be added.</summary>
49+
<param name="key">Name of the HTTP request option.</param>
50+
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.HttpRequestOptionsKey`1" /> class using the specified key name.</summary>
5151
<remarks>To be added.</remarks>
5252
</Docs>
5353
</Member>
@@ -68,7 +68,7 @@
6868
<ReturnType>System.String</ReturnType>
6969
</ReturnValue>
7070
<Docs>
71-
<summary>To be added.</summary>
71+
<summary>Gets the name of the option.</summary>
7272
<value>To be added.</value>
7373
<remarks>To be added.</remarks>
7474
</Docs>

0 commit comments

Comments
 (0)