Skip to content

Commit 393174a

Browse files
carlossanlopaik-jahoda
authored and
gewarren
committed
Automatic port of explicit interface implementation of System.Net.Http.HttpRequestOptions (dotnet#4881)
* Automatic port of explicit interface implementations for System.Net.Http.HttpRequestOptions * Apply suggestions from code review Co-authored-by: Jan Jahoda <aik.jahoda@post.cz> Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Jan Jahoda <aik.jahoda@post.cz>
1 parent 9473f33 commit 393174a

File tree

1 file changed

+176
-51
lines changed

1 file changed

+176
-51
lines changed

‎xml/System.Net.Http/HttpRequestOptions.xml‎

Lines changed: 176 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,17 @@
109109
<Parameter Name="item" Type="System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;" />
110110
</Parameters>
111111
<Docs>
112-
<param name="item">To be added.</param>
113-
<summary>To be added.</summary>
114-
<remarks>To be added.</remarks>
112+
<param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
113+
<summary>Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
114+
<remarks>
115+
<format type="text/markdown"><![CDATA[
116+
117+
## Remarks
118+
119+
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.ICollection%601> interface.
120+
121+
]]></format>
122+
</remarks>
115123
</Docs>
116124
</Member>
117125
<Member MemberName="System.Collections.Generic.ICollection&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;.Clear">
@@ -134,8 +142,16 @@
134142
</ReturnValue>
135143
<Parameters />
136144
<Docs>
137-
<summary>To be added.</summary>
138-
<remarks>To be added.</remarks>
145+
<summary>Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
146+
<remarks>
147+
<format type="text/markdown"><![CDATA[
148+
149+
## Remarks
150+
151+
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.ICollection%601> interface.
152+
153+
]]></format>
154+
</remarks>
139155
</Docs>
140156
</Member>
141157
<Member MemberName="System.Collections.Generic.ICollection&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;.Contains">
@@ -160,10 +176,19 @@
160176
<Parameter Name="item" Type="System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;" />
161177
</Parameters>
162178
<Docs>
163-
<param name="item">To be added.</param>
164-
<summary>To be added.</summary>
165-
<returns>To be added.</returns>
166-
<remarks>To be added.</remarks>
179+
<param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
180+
<summary>Determines whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains a specific value.</summary>
181+
<returns>
182+
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
183+
<remarks>
184+
<format type="text/markdown"><![CDATA[
185+
186+
## Remarks
187+
188+
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.ICollection%601> interface.
189+
190+
]]></format>
191+
</remarks>
167192
</Docs>
168193
</Member>
169194
<Member MemberName="System.Collections.Generic.ICollection&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;.CopyTo">
@@ -189,10 +214,18 @@
189214
<Parameter Name="arrayIndex" Type="System.Int32" />
190215
</Parameters>
191216
<Docs>
192-
<param name="array">To be added.</param>
193-
<param name="arrayIndex">To be added.</param>
194-
<summary>To be added.</summary>
195-
<remarks>To be added.</remarks>
217+
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from <see cref="T:System.Collections.Generic.ICollection`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
218+
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
219+
<summary>Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
220+
<remarks>
221+
<format type="text/markdown"><![CDATA[
222+
223+
## Remarks
224+
225+
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.ICollection%601> interface.
226+
227+
]]></format>
228+
</remarks>
196229
</Docs>
197230
</Member>
198231
<Member MemberName="System.Collections.Generic.ICollection&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;.Count">
@@ -214,9 +247,17 @@
214247
<ReturnType>System.Int32</ReturnType>
215248
</ReturnValue>
216249
<Docs>
217-
<summary>To be added.</summary>
218-
<value>To be added.</value>
219-
<remarks>To be added.</remarks>
250+
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
251+
<value>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</value>
252+
<remarks>
253+
<format type="text/markdown"><![CDATA[
254+
255+
## Remarks
256+
257+
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.ICollection%601> interface.
258+
259+
]]></format>
260+
</remarks>
220261
</Docs>
221262
</Member>
222263
<Member MemberName="System.Collections.Generic.ICollection&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;.IsReadOnly">
@@ -238,9 +279,18 @@
238279
<ReturnType>System.Boolean</ReturnType>
239280
</ReturnValue>
240281
<Docs>
241-
<summary>To be added.</summary>
242-
<value>To be added.</value>
243-
<remarks>To be added.</remarks>
282+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.</summary>
283+
<value>
284+
<see langword="true" /> if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, <see langword="false" />.</value>
285+
<remarks>
286+
<format type="text/markdown"><![CDATA[
287+
288+
## Remarks
289+
290+
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.ICollection%601> interface.
291+
292+
]]></format>
293+
</remarks>
244294
</Docs>
245295
</Member>
246296
<Member MemberName="System.Collections.Generic.ICollection&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;.Remove">
@@ -265,10 +315,19 @@
265315
<Parameter Name="item" Type="System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;" />
266316
</Parameters>
267317
<Docs>
268-
<param name="item">To be added.</param>
269-
<summary>To be added.</summary>
270-
<returns>To be added.</returns>
271-
<remarks>To be added.</remarks>
318+
<param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
319+
<summary>Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1" />.</summary>
320+
<returns>
321+
<see langword="true" /> if <paramref name="item" /> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.</returns>
322+
<remarks>
323+
<format type="text/markdown"><![CDATA[
324+
325+
## Remarks
326+
327+
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.ICollection%601> interface.
328+
329+
]]></format>
330+
</remarks>
272331
</Docs>
273332
</Member>
274333
<Member MemberName="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;.Add">
@@ -294,10 +353,18 @@
294353
<Parameter Name="value" Type="System.Object" />
295354
</Parameters>
296355
<Docs>
297-
<param name="key">To be added.</param>
298-
<param name="value">To be added.</param>
299-
<summary>To be added.</summary>
300-
<remarks>To be added.</remarks>
356+
<param name="key">The object to use as the key of the element to add.</param>
357+
<param name="value">The object to use as the value of the element to add.</param>
358+
<summary>Adds an element with the provided key and value to the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
359+
<remarks>
360+
<format type="text/markdown"><![CDATA[
361+
362+
## Remarks
363+
364+
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.
365+
366+
]]></format>
367+
</remarks>
301368
</Docs>
302369
</Member>
303370
<Member MemberName="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;.ContainsKey">
@@ -322,10 +389,19 @@
322389
<Parameter Name="key" Type="System.String" />
323390
</Parameters>
324391
<Docs>
325-
<param name="key">To be added.</param>
326-
<summary>To be added.</summary>
327-
<returns>To be added.</returns>
328-
<remarks>To be added.</remarks>
392+
<param name="key">The key to locate in the <see cref="T:System.Collections.Generic.IDictionary`2" />.</param>
393+
<summary>Determines whether the <see cref="T:System.Collections.Generic.IDictionary`2" /> contains an element with the specified key.</summary>
394+
<returns>
395+
<see langword="true" /> if the <see cref="T:System.Collections.Generic.IDictionary`2" /> contains an element with the key; otherwise, <see langword="false" />.</returns>
396+
<remarks>
397+
<format type="text/markdown"><![CDATA[
398+
399+
## Remarks
400+
401+
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.
402+
403+
]]></format>
404+
</remarks>
329405
</Docs>
330406
</Member>
331407
<Member MemberName="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;.Item">
@@ -350,10 +426,18 @@
350426
<Parameter Name="key" Type="System.String" />
351427
</Parameters>
352428
<Docs>
353-
<param name="key">To be added.</param>
354-
<summary>To be added.</summary>
355-
<value>To be added.</value>
356-
<remarks>To be added.</remarks>
429+
<param name="key">The key of the element to get or set.</param>
430+
<summary>Gets or sets the element with the specified key.</summary>
431+
<value>The element with the specified key.</value>
432+
<remarks>
433+
<format type="text/markdown"><![CDATA[
434+
435+
## Remarks
436+
437+
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.
438+
439+
]]></format>
440+
</remarks>
357441
</Docs>
358442
</Member>
359443
<Member MemberName="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;.Keys">
@@ -375,9 +459,17 @@
375459
<ReturnType>System.Collections.Generic.ICollection&lt;System.String&gt;</ReturnType>
376460
</ReturnValue>
377461
<Docs>
378-
<summary>To be added.</summary>
379-
<value>To be added.</value>
380-
<remarks>To be added.</remarks>
462+
<summary>Gets an <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
463+
<value>An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the object that implements <see cref="T:System.Collections.Generic.IDictionary`2" />.</value>
464+
<remarks>
465+
<format type="text/markdown"><![CDATA[
466+
467+
## Remarks
468+
469+
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.
470+
471+
]]></format>
472+
</remarks>
381473
</Docs>
382474
</Member>
383475
<Member MemberName="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;.Remove">
@@ -402,10 +494,19 @@
402494
<Parameter Name="key" Type="System.String" />
403495
</Parameters>
404496
<Docs>
405-
<param name="key">To be added.</param>
406-
<summary>To be added.</summary>
407-
<returns>To be added.</returns>
408-
<remarks>To be added.</remarks>
497+
<param name="key">The key of the element to remove.</param>
498+
<summary>Removes the element with the specified key from the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
499+
<returns>
500+
<see langword="true" /> if the element is successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="key" /> was not found in the original <see cref="T:System.Collections.Generic.IDictionary`2" />.</returns>
501+
<remarks>
502+
<format type="text/markdown"><![CDATA[
503+
504+
## Remarks
505+
506+
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.
507+
508+
]]></format>
509+
</remarks>
409510
</Docs>
410511
</Member>
411512
<Member MemberName="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;.TryGetValue">
@@ -454,9 +555,17 @@
454555
<ReturnType>System.Collections.Generic.ICollection&lt;System.Object&gt;</ReturnType>
455556
</ReturnValue>
456557
<Docs>
457-
<summary>To be added.</summary>
458-
<value>To be added.</value>
459-
<remarks>To be added.</remarks>
558+
<summary>Gets an <see cref="T:System.Collections.Generic.ICollection`1" /> containing the values in the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
559+
<value>An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the values in the object that implements <see cref="T:System.Collections.Generic.IDictionary`2" />.</value>
560+
<remarks>
561+
<format type="text/markdown"><![CDATA[
562+
563+
## Remarks
564+
565+
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.
566+
567+
]]></format>
568+
</remarks>
460569
</Docs>
461570
</Member>
462571
<Member MemberName="System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;.GetEnumerator">
@@ -479,9 +588,17 @@
479588
</ReturnValue>
480589
<Parameters />
481590
<Docs>
482-
<summary>To be added.</summary>
483-
<returns>To be added.</returns>
484-
<remarks>To be added.</remarks>
591+
<summary>Returns an enumerator that iterates through the collection.</summary>
592+
<returns>An enumerator that can be used to iterate through the collection.</returns>
593+
<remarks>
594+
<format type="text/markdown"><![CDATA[
595+
596+
## Remarks
597+
598+
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.IEnumerable%601> interface.
599+
600+
]]></format>
601+
</remarks>
485602
</Docs>
486603
</Member>
487604
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -504,9 +621,17 @@
504621
</ReturnValue>
505622
<Parameters />
506623
<Docs>
507-
<summary>To be added.</summary>
508-
<returns>To be added.</returns>
509-
<remarks>To be added.</remarks>
624+
<summary>Returns an enumerator that iterates through a collection.</summary>
625+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
626+
<remarks>
627+
<format type="text/markdown"><![CDATA[
628+
629+
## Remarks
630+
631+
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.IEnumerable> interface.
632+
633+
]]></format>
634+
</remarks>
510635
</Docs>
511636
</Member>
512637
<Member MemberName="TryGetValue&lt;TValue&gt;">

0 commit comments

Comments
 (0)