Skip to content

Commit 66b6eca

Browse files
Assorted missing docs for RC1 (#8391)
* Assorted missing docs for RC1 * which -> that * which -> that * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System.Diagnostics/TagList.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 0effa38 commit 66b6eca

19 files changed

+309
-308
lines changed

xml/System.Collections.Generic/PriorityQueue`2+UnorderedItemsCollection+Enumerator.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
</ReturnValue>
6161
<Docs>
6262
<summary>Gets the element at the current position of the enumerator.</summary>
63-
<value>To be added.</value>
63+
<value>The element in the collection at the current position of the enumerator.</value>
6464
<remarks>To be added.</remarks>
6565
</Docs>
6666
</Member>

xml/System.ComponentModel.Design.Serialization/SerializationStore.xml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@
4141
<Docs>
4242
<summary>Provides the base class for storing serialization data for the <see cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" />.</summary>
4343
<remarks>
44-
<format type="text/markdown"><![CDATA[
45-
46-
## Remarks
47-
The <xref:System.ComponentModel.Design.Serialization.SerializationStore> class is an implementation-specific class that stores serialization data for the <xref:System.ComponentModel.Design.Serialization.ComponentSerializationService>. The service adds state to this serialization store. Once the store is closed, it can be saved to a stream. A serialization store can be deserialized at a later time by the same type of serialization service. The <xref:System.ComponentModel.Design.Serialization.SerializationStore> class implements the <xref:System.IDisposable> interface so that <xref:System.ComponentModel.Design.Serialization.SerializationStore.System%23IDisposable%23Dispose%2A> simply calls the <xref:System.ComponentModel.Design.Serialization.SerializationStore.Close%2A> method.
48-
44+
<format type="text/markdown"><![CDATA[
45+
46+
## Remarks
47+
The <xref:System.ComponentModel.Design.Serialization.SerializationStore> class is an implementation-specific class that stores serialization data for the <xref:System.ComponentModel.Design.Serialization.ComponentSerializationService>. The service adds state to this serialization store. Once the store is closed, it can be saved to a stream. A serialization store can be deserialized at a later time by the same type of serialization service. The <xref:System.ComponentModel.Design.Serialization.SerializationStore> class implements the <xref:System.IDisposable> interface so that <xref:System.ComponentModel.Design.Serialization.SerializationStore.System%23IDisposable%23Dispose%2A> simply calls the <xref:System.ComponentModel.Design.Serialization.SerializationStore.Close%2A> method.
48+
4949
]]></format>
5050
</remarks>
5151
<altmember cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" />
@@ -128,11 +128,11 @@
128128
<Docs>
129129
<summary>Closes the serialization store.</summary>
130130
<remarks>
131-
<format type="text/markdown"><![CDATA[
132-
133-
## Remarks
134-
The <xref:System.ComponentModel.Design.Serialization.SerializationStore.Close%2A> method closes this store and prevents any objects from being serialized into it. Once closed, the serialization store may be saved.
135-
131+
<format type="text/markdown"><![CDATA[
132+
133+
## Remarks
134+
The <xref:System.ComponentModel.Design.Serialization.SerializationStore.Close%2A> method closes this store and prevents any objects from being serialized into it. Once closed, the serialization store may be saved.
135+
136136
]]></format>
137137
</remarks>
138138
</Docs>
@@ -176,19 +176,19 @@
176176
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
177177
<summary>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> and optionally releases the managed resources.</summary>
178178
<remarks>
179-
<format type="text/markdown"><![CDATA[
180-
181-
## Remarks
182-
This method is called by the public `Dispose()` method and the <xref:System.Object.Finalize%2A> method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. <xref:System.Object.Finalize%2A> invokes `Dispose` with `disposing` set to `false`.
183-
184-
When the `disposing` parameter is true, this method releases all resources held by any managed objects that this <xref:System.ComponentModel.Design.Serialization.SerializationStore> references. This method invokes the `Dispose()` method of each referenced object.
185-
179+
<format type="text/markdown"><![CDATA[
180+
181+
## Remarks
182+
This method is called by the public `Dispose()` method and the <xref:System.Object.Finalize%2A> method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. <xref:System.Object.Finalize%2A> invokes `Dispose` with `disposing` set to `false`.
183+
184+
When the `disposing` parameter is true, this method releases all resources held by any managed objects that this <xref:System.ComponentModel.Design.Serialization.SerializationStore> references. This method invokes the `Dispose()` method of each referenced object.
185+
186186
]]></format>
187187
</remarks>
188188
<block subset="none" type="overrides">
189189
<para>
190-
<see langword="Dispose" /> can be called multiple times by other objects. When overriding <see langword="Dispose(Boolean)" /> be careful not to reference objects that have been previously disposed of in an earlier call to <see langword="Dispose" />. For more information about how to implement <see langword="Dispose(Boolean)" />, see [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose).
191-
190+
<see langword="Dispose" /> can be called multiple times by other objects. When overriding <see langword="Dispose(Boolean)" /> be careful not to reference objects that have been previously disposed of in an earlier call to <see langword="Dispose" />. For more information about how to implement <see langword="Dispose(Boolean)" />, see [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose).
191+
192192
For more information about <see langword="Dispose" /> and <see cref="M:System.Object.Finalize" />, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Overriding the Finalize Method](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)).</para>
193193
</block>
194194
</Docs>
@@ -268,11 +268,11 @@
268268
<param name="stream">The stream to which the store will be serialized.</param>
269269
<summary>Saves the store to the given stream.</summary>
270270
<remarks>
271-
<format type="text/markdown"><![CDATA[
272-
273-
## Remarks
274-
If the store is open, the <xref:System.ComponentModel.Design.Serialization.SerializationStore.Save%2A> method will automatically close it for you. You can call <xref:System.ComponentModel.Design.Serialization.SerializationStore.Save%2A> as many times as you wish to save the store to different streams.
275-
271+
<format type="text/markdown"><![CDATA[
272+
273+
## Remarks
274+
If the store is open, the <xref:System.ComponentModel.Design.Serialization.SerializationStore.Save%2A> method will automatically close it for you. You can call <xref:System.ComponentModel.Design.Serialization.SerializationStore.Save%2A> as many times as you wish to save the store to different streams.
275+
276276
]]></format>
277277
</remarks>
278278
</Docs>
@@ -320,7 +320,7 @@
320320
<Parameters />
321321
<Docs>
322322
<summary>Releases all resources used by the <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" />.</summary>
323-
<remarks>To be added.</remarks>
323+
<remarks>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore"/> instance is cast to an <see cref="T:System.IDisposable"/> interface.</remarks>
324324
</Docs>
325325
</Member>
326326
</Members>

xml/System.ComponentModel.Design/DesignerOptionService+DesignerOptionCollection.xml

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@
6666
<Docs>
6767
<summary>Contains a collection of designer options. This class cannot be inherited.</summary>
6868
<remarks>
69-
<format type="text/markdown"><![CDATA[
70-
71-
## Remarks
72-
The <xref:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection> class is a collection that contains other <xref:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection> objects. This forms a tree of options, with each branch of the tree having a name and a possible collection of properties. Each parent branch of the tree contains a union of the properties of all the child branches.
73-
69+
<format type="text/markdown"><![CDATA[
70+
71+
## Remarks
72+
The <xref:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection> class is a collection that contains other <xref:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection> objects. This forms a tree of options, with each branch of the tree having a name and a possible collection of properties. Each parent branch of the tree contains a union of the properties of all the child branches.
73+
7474
]]></format>
7575
</remarks>
7676
<altmember cref="T:System.ComponentModel.Design.IDesignerOptionService" />
@@ -245,11 +245,11 @@
245245
<summary>Returns the index of the first occurrence of a given value in a range of this collection.</summary>
246246
<returns>The index of the first occurrence of value within the entire collection, if found; otherwise, the lower bound of the collection minus 1.</returns>
247247
<remarks>
248-
<format type="text/markdown"><![CDATA[
249-
250-
## Remarks
251-
The collection is searched, in one direction, from beginning to end.
252-
248+
<format type="text/markdown"><![CDATA[
249+
250+
## Remarks
251+
The collection is searched, in one direction, from beginning to end.
252+
253253
]]></format>
254254
</remarks>
255255
<altmember cref="Overload:System.Collections.ArrayList.IndexOf" />
@@ -347,11 +347,11 @@
347347
<summary>Gets the child collection at the given name.</summary>
348348
<value>The child collection with the name specified by the <paramref name="name" /> parameter, or <see langword="null" /> if the name is not found.</value>
349349
<remarks>
350-
<format type="text/markdown"><![CDATA[
351-
352-
## Remarks
353-
The name search is case-insensitive.
354-
350+
<format type="text/markdown"><![CDATA[
351+
352+
## Remarks
353+
The name search is case-insensitive.
354+
355355
]]></format>
356356
</remarks>
357357
</Docs>
@@ -397,11 +397,11 @@
397397
<summary>Gets the name of this <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" />.</summary>
398398
<value>The name of this <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" />.</value>
399399
<remarks>
400-
<format type="text/markdown"><![CDATA[
401-
402-
## Remarks
403-
Names are programmatic names and are not localized. A name search is case-insensitive.
404-
400+
<format type="text/markdown"><![CDATA[
401+
402+
## Remarks
403+
Names are programmatic names and are not localized. A name search is case-insensitive.
404+
405405
]]></format>
406406
</remarks>
407407
</Docs>
@@ -491,11 +491,11 @@
491491
<summary>Gets the collection of properties offered by this <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" />, along with all of its children.</summary>
492492
<value>The collection of properties offered by this <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" />, along with all of its children.</value>
493493
<remarks>
494-
<format type="text/markdown"><![CDATA[
495-
496-
## Remarks
497-
<xref:System.ComponentModel.PropertyDescriptor> objects are taken directly from the value passed to the <xref:System.ComponentModel.Design.DesignerOptionService.CreateOptionCollection%2A> method and are wrapped in an additional property descriptor that hides the value object from the user. This means that any value may be passed into the `component` parameter of the various <xref:System.ComponentModel.PropertyDescriptor> methods. The value is not recognized and is replaced with the correct value internally.
498-
494+
<format type="text/markdown"><![CDATA[
495+
496+
## Remarks
497+
<xref:System.ComponentModel.PropertyDescriptor> objects are taken directly from the value passed to the <xref:System.ComponentModel.Design.DesignerOptionService.CreateOptionCollection%2A> method and are wrapped in an additional property descriptor that hides the value object from the user. This means that any value may be passed into the `component` parameter of the various <xref:System.ComponentModel.PropertyDescriptor> methods. The value is not recognized and is replaced with the correct value internally.
498+
499499
]]></format>
500500
</remarks>
501501
<altmember cref="T:System.ComponentModel.Design.IDesignerOptionService" />
@@ -580,7 +580,7 @@
580580
<summary>Gets a value indicating whether access to the collection is synchronized and, therefore, thread safe.</summary>
581581
<value>
582582
<see langword="true" /> if the access to the collection is synchronized; otherwise, <see langword="false" />.</value>
583-
<remarks>To be added.</remarks>
583+
<remarks>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection"/> instance is cast to an <see cref="T:System.Collections.ICollection"/> interface.</remarks>
584584
</Docs>
585585
</Member>
586586
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -620,7 +620,7 @@
620620
<Docs>
621621
<summary>Gets an object that can be used to synchronize access to the collection.</summary>
622622
<value>An object that can be used to synchronize access to the collection.</value>
623-
<remarks>To be added.</remarks>
623+
<remarks>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection"/> instance is cast to an <see cref="T:System.Collections.ICollection"/> interface.</remarks>
624624
</Docs>
625625
</Member>
626626
<Member MemberName="System.Collections.IList.Add">
@@ -704,7 +704,7 @@
704704
<Parameters />
705705
<Docs>
706706
<summary>Removes all items from the collection.</summary>
707-
<remarks>To be added.</remarks>
707+
<remarks>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection"/> instance is cast to an <see cref="T:System.Collections.IList"/> interface.</remarks>
708708
</Docs>
709709
</Member>
710710
<Member MemberName="System.Collections.IList.Contains">
@@ -879,7 +879,7 @@
879879
<summary>Gets a value indicating whether the collection has a fixed size.</summary>
880880
<value>
881881
<see langword="true" /> if the collection has a fixed size; otherwise, <see langword="false" />.</value>
882-
<remarks>To be added.</remarks>
882+
<remarks>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection"/> instance is cast to an <see cref="T:System.Collections.IList"/> interface.</remarks>
883883
</Docs>
884884
</Member>
885885
<Member MemberName="System.Collections.IList.IsReadOnly">
@@ -920,7 +920,7 @@
920920
<summary>Gets a value indicating whether the collection is read-only.</summary>
921921
<value>
922922
<see langword="true" /> if the collection is read-only; otherwise, <see langword="false" />.</value>
923-
<remarks>To be added.</remarks>
923+
<remarks>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection"/> instance is cast to an <see cref="T:System.Collections.IList"/> interface.</remarks>
924924
</Docs>
925925
</Member>
926926
<Member MemberName="System.Collections.IList.Item">

xml/System.Diagnostics/ActivityTagsCollection.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ This collection behaves as follows:
300300
</ReturnValue>
301301
<Docs>
302302
<summary>Gets the number of elements contained in the collection.</summary>
303-
<value>To be added.</value>
303+
<value>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</value>
304304
<remarks>To be added.</remarks>
305305
</Docs>
306306
</Member>
@@ -411,7 +411,7 @@ This collection behaves as follows:
411411
</ReturnValue>
412412
<Docs>
413413
<summary>Get the list of the keys of all stored tags.</summary>
414-
<value>To be added.</value>
414+
<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>
415415
<remarks>To be added.</remarks>
416416
</Docs>
417417
</Member>
@@ -590,7 +590,7 @@ This member is an explicit interface member implementation. It can be used only
590590
</ReturnValue>
591591
<Docs>
592592
<summary>Get the list of the values of all stored tags.</summary>
593-
<value>To be added.</value>
593+
<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>
594594
<remarks>To be added.</remarks>
595595
</Docs>
596596
</Member>

xml/System.Diagnostics/TagList.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@
296296
</ReturnValue>
297297
<Docs>
298298
<summary>Gets the number of tags contained in the <see cref="T:System.Diagnostics.TagList" />.</summary>
299-
<value>To be added.</value>
299+
<value>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</value>
300300
<remarks>To be added.</remarks>
301301
</Docs>
302302
</Member>
@@ -426,7 +426,8 @@
426426
</ReturnValue>
427427
<Docs>
428428
<summary>Gets a value indicating whether the <see cref="T:System.Diagnostics.TagList" /> is read-only. This property will always return <see langword="false" />.</summary>
429-
<value>To be added.</value>
429+
<value>
430+
Always returns <see langword="false" />.</value>
430431
<remarks>To be added.</remarks>
431432
</Docs>
432433
</Member>
@@ -461,7 +462,7 @@
461462
<Docs>
462463
<param name="index">The item index.</param>
463464
<summary>Gets or sets the tags at the specified index.</summary>
464-
<value>To be added.</value>
465+
<value>The element at the specified index.</value>
465466
<remarks>To be added.</remarks>
466467
<exception cref="T:System.ArgumentOutOfRangeException">
467468
<paramref name="index" /> is not a valid index in the <see cref="T:System.Diagnostics.TagList" />.</exception>
@@ -556,7 +557,7 @@
556557
<Docs>
557558
<summary>Returns an enumerator that iterates through the <see cref="T:System.Diagnostics.TagList" />.</summary>
558559
<returns>An enumerator that iterates through the <see cref="T:System.Diagnostics.TagList" />.</returns>
559-
<remarks>To be added.</remarks>
560+
<remarks>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Diagnostics.TagList"/> instance is cast to an <see cref="T:System.Collections.IEnumerable"/> interface.</remarks>
560561
</Docs>
561562
</Member>
562563
</Members>

0 commit comments

Comments
 (0)