Automatic port of System.Drawing documentation (#4628)

* Automatic port of System.Drawing documentation * Update EncoderParameterValueType.xml I updated the enum and field summaries to match the wiki. * Typo * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
dotnet · BillWagner · Aug 12, 2020 · Aug 11, 2020 · Aug 11, 2020 · Aug 11, 2020
commit 777b90f384fdf71f83312052211734824444793c
diff --git a/xml/System.Drawing.Design/ToolboxService.xml b/xml/System.Drawing.Design/ToolboxService.xml
@@ -1,4 +1,4 @@
-<Type Name="ToolboxService" FullName="System.Drawing.Design.ToolboxService">
+<Type Name="ToolboxService" FullName="System.Drawing.Design.ToolboxService">
   <TypeSignature Language="C#" Value="public abstract class ToolboxService : System.ComponentModel.Design.IComponentDiscoveryService, System.Drawing.Design.IToolboxService" />
   <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ToolboxService extends System.Object implements class System.ComponentModel.Design.IComponentDiscoveryService, class System.Drawing.Design.IToolboxService" />
   <TypeSignature Language="DocId" Value="T:System.Drawing.Design.ToolboxService" />
@@ -1597,7 +1597,15 @@
       <Parameters />
       <Docs>
         <summary>Refreshes the state of the toolbox items.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+This member is an explicit interface member implementation. It can be used only when the <xref:System.Drawing.Design.ToolboxService> instance is cast to an <xref:System.Drawing.Design.IToolboxService> interface.
+
+          ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <MemberGroup MemberName="System.Drawing.Design.IToolboxService.RemoveCreator">
@@ -1876,7 +1884,15 @@
         <summary>Sets the current application's cursor to a cursor that represents the currently selected tool.</summary>
         <returns>
           <see langword="true" /> if the cursor is set by the currently selected tool; <see langword="false" /> if there is no tool selected and the cursor is set to the standard Windows cursor.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+This member is an explicit interface member implementation. It can be used only when the <xref:System.Drawing.Design.ToolboxService> instance is cast to an <xref:System.Drawing.Design.IToolboxService> interface.
+
+          ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="System.Drawing.Design.IToolboxService.SetSelectedToolboxItem">

diff --git a/xml/System.Drawing.Imaging/Encoder.xml b/xml/System.Drawing.Imaging/Encoder.xml
@@ -1,4 +1,4 @@
-<Type Name="Encoder" FullName="System.Drawing.Imaging.Encoder">
+<Type Name="Encoder" FullName="System.Drawing.Imaging.Encoder">
   <TypeSignature Language="C#" Value="public sealed class Encoder" />
   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Encoder extends System.Object" />
   <TypeSignature Language="DocId" Value="T:System.Drawing.Imaging.Encoder" />
@@ -307,7 +307,7 @@
         <ReturnType>System.Drawing.Imaging.Encoder</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Represents an encoder that's initialized with the globally unique identifier for the color space category.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -483,7 +483,7 @@
         <ReturnType>System.Drawing.Imaging.Encoder</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Represents an encoder that's initialized with the globally unique identifier for the image items category.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -724,7 +724,7 @@
         <ReturnType>System.Drawing.Imaging.Encoder</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Represents an encoder that's initialized with the globally unique identifier for the save as CMYK category.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/System.Drawing.Imaging/EncoderParameterValueType.xml b/xml/System.Drawing.Imaging/EncoderParameterValueType.xml
@@ -1,4 +1,4 @@
-<Type Name="EncoderParameterValueType" FullName="System.Drawing.Imaging.EncoderParameterValueType">
+<Type Name="EncoderParameterValueType" FullName="System.Drawing.Imaging.EncoderParameterValueType">
   <TypeSignature Language="C#" Value="public enum EncoderParameterValueType" />
   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed EncoderParameterValueType extends System.Enum" />
   <TypeSignature Language="DocId" Value="T:System.Drawing.Imaging.EncoderParameterValueType" />
@@ -23,7 +23,7 @@
     <BaseTypeName>System.Enum</BaseTypeName>
   </Base>
   <Docs>
-    <summary>Used to specify the data type of the <see cref="T:System.Drawing.Imaging.EncoderParameter" /> used with the <see cref="Overload:System.Drawing.Image.Save" /> or <see cref="Overload:System.Drawing.Image.SaveAdd" /> method of an image.</summary>
+    <summary>Specifies the data type of the <see cref="T:System.Drawing.Imaging.EncoderParameter" /> used with the <see cref="Overload:System.Drawing.Image.Save" /> or <see cref="Overload:System.Drawing.Image.SaveAdd" /> method of an image.</summary>
     <remarks>
       <format type="text/markdown"><![CDATA[
 
@@ -64,7 +64,16 @@
       </ReturnValue>
       <MemberValue>2</MemberValue>
       <Docs>
-        <summary>Specifies that the array of values is a null-terminated ASCII character string. Note that the <see langword="NumberOfValues" /> data member of the <see cref="T:System.Drawing.Imaging.EncoderParameter" /> object indicates the length of the character string including the NULL terminator.</summary>
+        <summary>An 8-bit ASCII value.</summary>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+## Remarks
+
+Specifies that the array of values is a null-terminated ASCII character string.
+
+The <see langword="NumberOfValues" /> data member of the <see cref="T:System.Drawing.Imaging.EncoderParameter" /> object indicates the length of the character string including the NULL terminator.
+       ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="ValueTypeByte">
@@ -94,7 +103,8 @@
       </ReturnValue>
       <MemberValue>1</MemberValue>
       <Docs>
-        <summary>Specifies that each value in the array is an 8-bit unsigned integer.</summary>
+        <summary>An 8-bit unsigned integer.</summary>
+        <remarks>To be added.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ValueTypeLong">
@@ -124,7 +134,8 @@
       </ReturnValue>
       <MemberValue>4</MemberValue>
       <Docs>
-        <summary>Specifies that each value in the array is a 32-bit unsigned integer.</summary>
+        <summary>A 32-bit unsigned integer.</summary>
+        <remarks>To be added.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ValueTypeLongRange">
@@ -154,7 +165,15 @@
       </ReturnValue>
       <MemberValue>6</MemberValue>
       <Docs>
-        <summary>Specifies that each value in the array is a pair of 32-bit unsigned integers. Each pair represents a range of numbers.</summary>
+        <summary>Two long values that specify a range of integer values.</summary>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+The first value specifies the lower end, and the second value specifies the higher end. All values are inclusive at both ends.
+       ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="ValueTypePointer">
@@ -174,7 +193,8 @@
       </ReturnValue>
       <MemberValue>9</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>A pointer to a block of custom metadata.</summary>
+        <remarks>To be added.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ValueTypeRational">
@@ -204,7 +224,8 @@
       </ReturnValue>
       <MemberValue>5</MemberValue>
       <Docs>
-        <summary>Specifies that each value in the array is a pair of 32-bit unsigned integers. Each pair represents a fraction, the first integer being the numerator and the second integer being the denominator.</summary>
+        <summary>A pair of 32-bit unsigned integers. Each pair represents a fraction, the first integer being the numerator and the second integer being the denominator.</summary>
+        <remarks>To be added.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ValueTypeRationalRange">
@@ -234,7 +255,17 @@
       </ReturnValue>
       <MemberValue>8</MemberValue>
       <Docs>
-        <summary>Specifies that each value in the array is a set of four, 32-bit unsigned integers. The first two integers represent one fraction, and the second two integers represent a second fraction. The two fractions represent a range of rational numbers. The first fraction is the smallest rational number in the range, and the second fraction is the largest rational number in the range.</summary>
+        <summary>A set of four, 32-bit unsigned integers. The first two integers represent one fraction, and the second two integers represent a second fraction.</summary>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+The two fractions represent a range of rational numbers. The first fraction is the smallest rational number in the range, and the second fraction is the largest rational number in the range.
+
+The values are inclusive at both ends.
+       ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="ValueTypeShort">
@@ -264,7 +295,8 @@
       </ReturnValue>
       <MemberValue>3</MemberValue>
       <Docs>
-        <summary>Specifies that each value in the array is a 16-bit, unsigned integer.</summary>
+        <summary>A 16-bit, unsigned integer.</summary>
+        <remarks>To be added.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ValueTypeUndefined">
@@ -294,7 +326,15 @@
       </ReturnValue>
       <MemberValue>7</MemberValue>
       <Docs>
-        <summary>Specifies that the array of values is an array of bytes that has no data type defined.</summary>
+        <summary>A byte that has no data type defined.</summary>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+The variable can take any value depending on field definition.
+       ]]></format>
+        </remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/xml/System.Drawing.Printing/PrinterSettings+PaperSizeCollection.xml b/xml/System.Drawing.Printing/PrinterSettings+PaperSizeCollection.xml
@@ -1,4 +1,4 @@
-<Type Name="PrinterSettings+PaperSizeCollection" FullName="System.Drawing.Printing.PrinterSettings+PaperSizeCollection">
+<Type Name="PrinterSettings+PaperSizeCollection" FullName="System.Drawing.Printing.PrinterSettings+PaperSizeCollection">
   <TypeSignature Language="C#" Value="public class PrinterSettings.PaperSizeCollection : System.Collections.ICollection" />
   <TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit PrinterSettings/PaperSizeCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
   <TypeSignature Language="DocId" Value="T:System.Drawing.Printing.PrinterSettings.PaperSizeCollection" />
@@ -391,7 +391,7 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</summary>
-        <value>To be added.</value>
+        <value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -431,7 +431,8 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</summary>
-        <value>To be added.</value>
+        <value>
+          <see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -471,7 +472,7 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</summary>
-        <value>To be added.</value>
+        <value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 

diff --git a/xml/System.Drawing.Printing/PrinterSettings+PaperSourceCollection.xml b/xml/System.Drawing.Printing/PrinterSettings+PaperSourceCollection.xml
@@ -1,4 +1,4 @@
-<Type Name="PrinterSettings+PaperSourceCollection" FullName="System.Drawing.Printing.PrinterSettings+PaperSourceCollection">
+<Type Name="PrinterSettings+PaperSourceCollection" FullName="System.Drawing.Printing.PrinterSettings+PaperSourceCollection">
   <TypeSignature Language="C#" Value="public class PrinterSettings.PaperSourceCollection : System.Collections.ICollection" />
   <TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit PrinterSettings/PaperSourceCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
   <TypeSignature Language="DocId" Value="T:System.Drawing.Printing.PrinterSettings.PaperSourceCollection" />
@@ -389,7 +389,7 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</summary>
-        <value>To be added.</value>
+        <value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -429,7 +429,8 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</summary>
-        <value>To be added.</value>
+        <value>
+          <see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -469,7 +470,7 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</summary>
-        <value>To be added.</value>
+        <value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -517,7 +518,7 @@
       <Parameters />
       <Docs>
         <summary>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</summary>
-        <returns>To be added.</returns>
+        <returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 

diff --git a/xml/System.Drawing.Printing/PrinterSettings+PrinterResolutionCollection.xml b/xml/System.Drawing.Printing/PrinterSettings+PrinterResolutionCollection.xml
@@ -1,4 +1,4 @@
-<Type Name="PrinterSettings+PrinterResolutionCollection" FullName="System.Drawing.Printing.PrinterSettings+PrinterResolutionCollection">
+<Type Name="PrinterSettings+PrinterResolutionCollection" FullName="System.Drawing.Printing.PrinterSettings+PrinterResolutionCollection">
   <TypeSignature Language="C#" Value="public class PrinterSettings.PrinterResolutionCollection : System.Collections.ICollection" />
   <TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit PrinterSettings/PrinterResolutionCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
   <TypeSignature Language="DocId" Value="T:System.Drawing.Printing.PrinterSettings.PrinterResolutionCollection" />
@@ -390,7 +390,7 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</summary>
-        <value>To be added.</value>
+        <value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -430,7 +430,8 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</summary>
-        <value>To be added.</value>
+        <value>
+          <see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -470,7 +471,7 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</summary>
-        <value>To be added.</value>
+        <value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -518,7 +519,7 @@
       <Parameters />
       <Docs>
         <summary>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</summary>
-        <returns>To be added.</returns>
+        <returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 

diff --git a/xml/System.Drawing.Printing/PrinterSettings+StringCollection.xml b/xml/System.Drawing.Printing/PrinterSettings+StringCollection.xml
@@ -1,4 +1,4 @@
-<Type Name="PrinterSettings+StringCollection" FullName="System.Drawing.Printing.PrinterSettings+StringCollection">
+<Type Name="PrinterSettings+StringCollection" FullName="System.Drawing.Printing.PrinterSettings+StringCollection">
   <TypeSignature Language="C#" Value="public class PrinterSettings.StringCollection : System.Collections.ICollection" />
   <TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit PrinterSettings/StringCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
   <TypeSignature Language="DocId" Value="T:System.Drawing.Printing.PrinterSettings.StringCollection" />
@@ -359,7 +359,7 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</summary>
-        <value>To be added.</value>
+        <value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -399,7 +399,8 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</summary>
-        <value>To be added.</value>
+        <value>
+          <see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -439,7 +440,7 @@
       </ReturnValue>
       <Docs>
         <summary>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</summary>
-        <value>To be added.</value>
+        <value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
         <remarks>
           <format type="text/markdown"><![CDATA[  
 
@@ -487,7 +488,7 @@
       <Parameters />
       <Docs>
         <summary>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</summary>
-        <returns>To be added.</returns>
+        <returns>An enumerator that can be used to iterate through the collection.</returns>
         <remarks>
           <format type="text/markdown"><![CDATA[