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]>
dotnet · gewarren · Sep 15, 2022 · Sep 12, 2022 · Sep 14, 2022 · Sep 14, 2022
commit 66b6ecafd1160987fb248fc66860cd08e1030c20
@@ -60,7 +60,7 @@
       </ReturnValue>
       <Docs>
         <summary>Gets the element at the current position of the enumerator.</summary>
-        <value>To be added.</value>
+        <value>The element in the collection at the current position of the enumerator.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

@@ -41,11 +41,11 @@
   <Docs>
     <summary>Provides the base class for storing serialization data for the <see cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" />.</summary>
     <remarks>
-      <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- 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.  
-  
+      <format type="text/markdown"><![CDATA[
+
+## Remarks
+ 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.
+
  ]]></format>
     </remarks>
     <altmember cref="T:System.ComponentModel.Design.Serialization.ComponentSerializationService" />
@@ -128,11 +128,11 @@
       <Docs>
         <summary>Closes the serialization store.</summary>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- 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.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ 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.
+
  ]]></format>
         </remarks>
       </Docs>
@@ -176,19 +176,19 @@
           <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
         <summary>Releases the unmanaged resources used by the <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" /> and optionally releases the managed resources.</summary>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- 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`.  
-  
- 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.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ 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`.
+
+ 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.
+
  ]]></format>
         </remarks>
         <block subset="none" type="overrides">
           <para>
-            <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).  
-  
+            <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).
+
  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>
         </block>
       </Docs>
@@ -268,11 +268,11 @@
         <param name="stream">The stream to which the store will be serialized.</param>
         <summary>Saves the store to the given stream.</summary>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- 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.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ 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.
+
  ]]></format>
         </remarks>
       </Docs>
@@ -320,7 +320,7 @@
       <Parameters />
       <Docs>
         <summary>Releases all resources used by the <see cref="T:System.ComponentModel.Design.Serialization.SerializationStore" />.</summary>
-        <remarks>To be added.</remarks>
+        <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>
       </Docs>
     </Member>
   </Members>

@@ -66,11 +66,11 @@
   <Docs>
     <summary>Contains a collection of designer options. This class cannot be inherited.</summary>
     <remarks>
-      <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- 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.  
-  
+      <format type="text/markdown"><![CDATA[
+
+## Remarks
+ 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.
+
  ]]></format>
     </remarks>
     <altmember cref="T:System.ComponentModel.Design.IDesignerOptionService" />
@@ -245,11 +245,11 @@
         <summary>Returns the index of the first occurrence of a given value in a range of this collection.</summary>
         <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>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- The collection is searched, in one direction, from beginning to end.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ The collection is searched, in one direction, from beginning to end.
+
  ]]></format>
         </remarks>
         <altmember cref="Overload:System.Collections.ArrayList.IndexOf" />
@@ -347,11 +347,11 @@
         <summary>Gets the child collection at the given name.</summary>
         <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>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- The name search is case-insensitive.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ The name search is case-insensitive.
+
  ]]></format>
         </remarks>
       </Docs>
@@ -397,11 +397,11 @@
         <summary>Gets the name of this <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" />.</summary>
         <value>The name of this <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" />.</value>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- Names are programmatic names and are not localized. A name search is case-insensitive.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ Names are programmatic names and are not localized. A name search is case-insensitive.
+
  ]]></format>
         </remarks>
       </Docs>
@@ -491,11 +491,11 @@
         <summary>Gets the collection of properties offered by this <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" />, along with all of its children.</summary>
         <value>The collection of properties offered by this <see cref="T:System.ComponentModel.Design.DesignerOptionService.DesignerOptionCollection" />, along with all of its children.</value>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- <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.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ <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.
+
  ]]></format>
         </remarks>
         <altmember cref="T:System.ComponentModel.Design.IDesignerOptionService" />
@@ -580,7 +580,7 @@
         <summary>Gets a value indicating whether access to the collection is synchronized and, therefore, thread safe.</summary>
         <value>
           <see langword="true" /> if the access to the collection is synchronized; otherwise, <see langword="false" />.</value>
-        <remarks>To be added.</remarks>
+        <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>
       </Docs>
     </Member>
     <Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -620,7 +620,7 @@
       <Docs>
         <summary>Gets an object that can be used to synchronize access to the collection.</summary>
         <value>An object that can be used to synchronize access to the collection.</value>
-        <remarks>To be added.</remarks>
+        <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>
       </Docs>
     </Member>
     <Member MemberName="System.Collections.IList.Add">
@@ -704,7 +704,7 @@
       <Parameters />
       <Docs>
         <summary>Removes all items from the collection.</summary>
-        <remarks>To be added.</remarks>
+        <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>
       </Docs>
     </Member>
     <Member MemberName="System.Collections.IList.Contains">
@@ -879,7 +879,7 @@
         <summary>Gets a value indicating whether the collection has a fixed size.</summary>
         <value>
           <see langword="true" /> if the collection has a fixed size; otherwise, <see langword="false" />.</value>
-        <remarks>To be added.</remarks>
+        <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>
       </Docs>
     </Member>
     <Member MemberName="System.Collections.IList.IsReadOnly">
@@ -920,7 +920,7 @@
         <summary>Gets a value indicating whether the collection is read-only.</summary>
         <value>
           <see langword="true" /> if the collection is read-only; otherwise, <see langword="false" />.</value>
-        <remarks>To be added.</remarks>
+        <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>
       </Docs>
     </Member>
     <Member MemberName="System.Collections.IList.Item">

@@ -300,7 +300,7 @@ This collection behaves as follows:
       </ReturnValue>
       <Docs>
         <summary>Gets the number of elements contained in the collection.</summary>
-        <value>To be added.</value>
+        <value>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -411,7 +411,7 @@ This collection behaves as follows:
       </ReturnValue>
       <Docs>
         <summary>Get the list of the keys of all stored tags.</summary>
-        <value>To be added.</value>
+        <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>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -590,7 +590,7 @@ This member is an explicit interface member implementation. It can be used only
       </ReturnValue>
       <Docs>
         <summary>Get the list of the values of all stored tags.</summary>
-        <value>To be added.</value>
+        <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>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

@@ -296,7 +296,7 @@
       </ReturnValue>
       <Docs>
         <summary>Gets the number of tags contained in the <see cref="T:System.Diagnostics.TagList" />.</summary>
-        <value>To be added.</value>
+        <value>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -426,7 +426,8 @@
       </ReturnValue>
       <Docs>
         <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>
-        <value>To be added.</value>
+        <value>
+          Always returns <see langword="false" />.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -461,7 +462,7 @@
       <Docs>
         <param name="index">The item index.</param>
         <summary>Gets or sets the tags at the specified index.</summary>
-        <value>To be added.</value>
+        <value>The element at the specified index.</value>
         <remarks>To be added.</remarks>
         <exception cref="T:System.ArgumentOutOfRangeException">
           <paramref name="index" /> is not a valid index in the <see cref="T:System.Diagnostics.TagList" />.</exception>
@@ -556,7 +557,7 @@
       <Docs>
         <summary>Returns an enumerator that iterates through the <see cref="T:System.Diagnostics.TagList" />.</summary>
         <returns>An enumerator that iterates through the <see cref="T:System.Diagnostics.TagList" />.</returns>
-        <remarks>To be added.</remarks>
+        <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>
       </Docs>
     </Member>
   </Members>