Skip to content

Commit 777b90f

Browse files
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]>
1 parent c6a6dfd commit 777b90f

14 files changed

+137
-63
lines changed

xml/System.Drawing.Design/ToolboxService.xml

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ToolboxService" FullName="System.Drawing.Design.ToolboxService">
1+
<Type Name="ToolboxService" FullName="System.Drawing.Design.ToolboxService">
22
<TypeSignature Language="C#" Value="public abstract class ToolboxService : System.ComponentModel.Design.IComponentDiscoveryService, System.Drawing.Design.IToolboxService" />
33
<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" />
44
<TypeSignature Language="DocId" Value="T:System.Drawing.Design.ToolboxService" />
@@ -1597,7 +1597,15 @@
15971597
<Parameters />
15981598
<Docs>
15991599
<summary>Refreshes the state of the toolbox items.</summary>
1600-
<remarks>To be added.</remarks>
1600+
<remarks>
1601+
<format type="text/markdown"><![CDATA[
1602+
1603+
## Remarks
1604+
1605+
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.
1606+
1607+
]]></format>
1608+
</remarks>
16011609
</Docs>
16021610
</Member>
16031611
<MemberGroup MemberName="System.Drawing.Design.IToolboxService.RemoveCreator">
@@ -1876,7 +1884,15 @@
18761884
<summary>Sets the current application's cursor to a cursor that represents the currently selected tool.</summary>
18771885
<returns>
18781886
<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>
1879-
<remarks>To be added.</remarks>
1887+
<remarks>
1888+
<format type="text/markdown"><![CDATA[
1889+
1890+
## Remarks
1891+
1892+
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.
1893+
1894+
]]></format>
1895+
</remarks>
18801896
</Docs>
18811897
</Member>
18821898
<Member MemberName="System.Drawing.Design.IToolboxService.SetSelectedToolboxItem">

xml/System.Drawing.Imaging/Encoder.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="Encoder" FullName="System.Drawing.Imaging.Encoder">
1+
<Type Name="Encoder" FullName="System.Drawing.Imaging.Encoder">
22
<TypeSignature Language="C#" Value="public sealed class Encoder" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Encoder extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Drawing.Imaging.Encoder" />
@@ -307,7 +307,7 @@
307307
<ReturnType>System.Drawing.Imaging.Encoder</ReturnType>
308308
</ReturnValue>
309309
<Docs>
310-
<summary>To be added.</summary>
310+
<summary>Represents an encoder that's initialized with the globally unique identifier for the color space category.</summary>
311311
<remarks>To be added.</remarks>
312312
</Docs>
313313
</Member>
@@ -483,7 +483,7 @@
483483
<ReturnType>System.Drawing.Imaging.Encoder</ReturnType>
484484
</ReturnValue>
485485
<Docs>
486-
<summary>To be added.</summary>
486+
<summary>Represents an encoder that's initialized with the globally unique identifier for the image items category.</summary>
487487
<remarks>To be added.</remarks>
488488
</Docs>
489489
</Member>
@@ -724,7 +724,7 @@
724724
<ReturnType>System.Drawing.Imaging.Encoder</ReturnType>
725725
</ReturnValue>
726726
<Docs>
727-
<summary>To be added.</summary>
727+
<summary>Represents an encoder that's initialized with the globally unique identifier for the save as CMYK category.</summary>
728728
<remarks>To be added.</remarks>
729729
</Docs>
730730
</Member>

xml/System.Drawing.Imaging/EncoderParameterValueType.xml

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="EncoderParameterValueType" FullName="System.Drawing.Imaging.EncoderParameterValueType">
1+
<Type Name="EncoderParameterValueType" FullName="System.Drawing.Imaging.EncoderParameterValueType">
22
<TypeSignature Language="C#" Value="public enum EncoderParameterValueType" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed EncoderParameterValueType extends System.Enum" />
44
<TypeSignature Language="DocId" Value="T:System.Drawing.Imaging.EncoderParameterValueType" />
@@ -23,7 +23,7 @@
2323
<BaseTypeName>System.Enum</BaseTypeName>
2424
</Base>
2525
<Docs>
26-
<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>
26+
<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>
2727
<remarks>
2828
<format type="text/markdown"><![CDATA[
2929
@@ -64,7 +64,16 @@
6464
</ReturnValue>
6565
<MemberValue>2</MemberValue>
6666
<Docs>
67-
<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>
67+
<summary>An 8-bit ASCII value.</summary>
68+
<remarks>
69+
<format type="text/markdown"><![CDATA[
70+
## Remarks
71+
72+
Specifies that the array of values is a null-terminated ASCII character string.
73+
74+
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.
75+
]]></format>
76+
</remarks>
6877
</Docs>
6978
</Member>
7079
<Member MemberName="ValueTypeByte">
@@ -94,7 +103,8 @@
94103
</ReturnValue>
95104
<MemberValue>1</MemberValue>
96105
<Docs>
97-
<summary>Specifies that each value in the array is an 8-bit unsigned integer.</summary>
106+
<summary>An 8-bit unsigned integer.</summary>
107+
<remarks>To be added.</remarks>
98108
</Docs>
99109
</Member>
100110
<Member MemberName="ValueTypeLong">
@@ -124,7 +134,8 @@
124134
</ReturnValue>
125135
<MemberValue>4</MemberValue>
126136
<Docs>
127-
<summary>Specifies that each value in the array is a 32-bit unsigned integer.</summary>
137+
<summary>A 32-bit unsigned integer.</summary>
138+
<remarks>To be added.</remarks>
128139
</Docs>
129140
</Member>
130141
<Member MemberName="ValueTypeLongRange">
@@ -154,7 +165,15 @@
154165
</ReturnValue>
155166
<MemberValue>6</MemberValue>
156167
<Docs>
157-
<summary>Specifies that each value in the array is a pair of 32-bit unsigned integers. Each pair represents a range of numbers.</summary>
168+
<summary>Two long values that specify a range of integer values.</summary>
169+
<remarks>
170+
<format type="text/markdown"><![CDATA[
171+
172+
## Remarks
173+
174+
The first value specifies the lower end, and the second value specifies the higher end. All values are inclusive at both ends.
175+
]]></format>
176+
</remarks>
158177
</Docs>
159178
</Member>
160179
<Member MemberName="ValueTypePointer">
@@ -174,7 +193,8 @@
174193
</ReturnValue>
175194
<MemberValue>9</MemberValue>
176195
<Docs>
177-
<summary>To be added.</summary>
196+
<summary>A pointer to a block of custom metadata.</summary>
197+
<remarks>To be added.</remarks>
178198
</Docs>
179199
</Member>
180200
<Member MemberName="ValueTypeRational">
@@ -204,7 +224,8 @@
204224
</ReturnValue>
205225
<MemberValue>5</MemberValue>
206226
<Docs>
207-
<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>
227+
<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>
228+
<remarks>To be added.</remarks>
208229
</Docs>
209230
</Member>
210231
<Member MemberName="ValueTypeRationalRange">
@@ -234,7 +255,17 @@
234255
</ReturnValue>
235256
<MemberValue>8</MemberValue>
236257
<Docs>
237-
<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>
258+
<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>
259+
<remarks>
260+
<format type="text/markdown"><![CDATA[
261+
262+
## Remarks
263+
264+
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.
265+
266+
The values are inclusive at both ends.
267+
]]></format>
268+
</remarks>
238269
</Docs>
239270
</Member>
240271
<Member MemberName="ValueTypeShort">
@@ -264,7 +295,8 @@
264295
</ReturnValue>
265296
<MemberValue>3</MemberValue>
266297
<Docs>
267-
<summary>Specifies that each value in the array is a 16-bit, unsigned integer.</summary>
298+
<summary>A 16-bit, unsigned integer.</summary>
299+
<remarks>To be added.</remarks>
268300
</Docs>
269301
</Member>
270302
<Member MemberName="ValueTypeUndefined">
@@ -294,7 +326,15 @@
294326
</ReturnValue>
295327
<MemberValue>7</MemberValue>
296328
<Docs>
297-
<summary>Specifies that the array of values is an array of bytes that has no data type defined.</summary>
329+
<summary>A byte that has no data type defined.</summary>
330+
<remarks>
331+
<format type="text/markdown"><![CDATA[
332+
333+
## Remarks
334+
335+
The variable can take any value depending on field definition.
336+
]]></format>
337+
</remarks>
298338
</Docs>
299339
</Member>
300340
</Members>

xml/System.Drawing.Printing/PrinterSettings+PaperSizeCollection.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PrinterSettings+PaperSizeCollection" FullName="System.Drawing.Printing.PrinterSettings+PaperSizeCollection">
1+
<Type Name="PrinterSettings+PaperSizeCollection" FullName="System.Drawing.Printing.PrinterSettings+PaperSizeCollection">
22
<TypeSignature Language="C#" Value="public class PrinterSettings.PaperSizeCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit PrinterSettings/PaperSizeCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Drawing.Printing.PrinterSettings.PaperSizeCollection" />
@@ -391,7 +391,7 @@
391391
</ReturnValue>
392392
<Docs>
393393
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</summary>
394-
<value>To be added.</value>
394+
<value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
395395
<remarks>
396396
<format type="text/markdown"><![CDATA[
397397
@@ -431,7 +431,8 @@
431431
</ReturnValue>
432432
<Docs>
433433
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</summary>
434-
<value>To be added.</value>
434+
<value>
435+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
435436
<remarks>
436437
<format type="text/markdown"><![CDATA[
437438
@@ -471,7 +472,7 @@
471472
</ReturnValue>
472473
<Docs>
473474
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</summary>
474-
<value>To be added.</value>
475+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
475476
<remarks>
476477
<format type="text/markdown"><![CDATA[
477478

xml/System.Drawing.Printing/PrinterSettings+PaperSourceCollection.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PrinterSettings+PaperSourceCollection" FullName="System.Drawing.Printing.PrinterSettings+PaperSourceCollection">
1+
<Type Name="PrinterSettings+PaperSourceCollection" FullName="System.Drawing.Printing.PrinterSettings+PaperSourceCollection">
22
<TypeSignature Language="C#" Value="public class PrinterSettings.PaperSourceCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit PrinterSettings/PaperSourceCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Drawing.Printing.PrinterSettings.PaperSourceCollection" />
@@ -389,7 +389,7 @@
389389
</ReturnValue>
390390
<Docs>
391391
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</summary>
392-
<value>To be added.</value>
392+
<value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
393393
<remarks>
394394
<format type="text/markdown"><![CDATA[
395395
@@ -429,7 +429,8 @@
429429
</ReturnValue>
430430
<Docs>
431431
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</summary>
432-
<value>To be added.</value>
432+
<value>
433+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
433434
<remarks>
434435
<format type="text/markdown"><![CDATA[
435436
@@ -469,7 +470,7 @@
469470
</ReturnValue>
470471
<Docs>
471472
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</summary>
472-
<value>To be added.</value>
473+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
473474
<remarks>
474475
<format type="text/markdown"><![CDATA[
475476
@@ -517,7 +518,7 @@
517518
<Parameters />
518519
<Docs>
519520
<summary>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</summary>
520-
<returns>To be added.</returns>
521+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
521522
<remarks>
522523
<format type="text/markdown"><![CDATA[
523524

xml/System.Drawing.Printing/PrinterSettings+PrinterResolutionCollection.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PrinterSettings+PrinterResolutionCollection" FullName="System.Drawing.Printing.PrinterSettings+PrinterResolutionCollection">
1+
<Type Name="PrinterSettings+PrinterResolutionCollection" FullName="System.Drawing.Printing.PrinterSettings+PrinterResolutionCollection">
22
<TypeSignature Language="C#" Value="public class PrinterSettings.PrinterResolutionCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit PrinterSettings/PrinterResolutionCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Drawing.Printing.PrinterSettings.PrinterResolutionCollection" />
@@ -390,7 +390,7 @@
390390
</ReturnValue>
391391
<Docs>
392392
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</summary>
393-
<value>To be added.</value>
393+
<value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
394394
<remarks>
395395
<format type="text/markdown"><![CDATA[
396396
@@ -430,7 +430,8 @@
430430
</ReturnValue>
431431
<Docs>
432432
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</summary>
433-
<value>To be added.</value>
433+
<value>
434+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
434435
<remarks>
435436
<format type="text/markdown"><![CDATA[
436437
@@ -470,7 +471,7 @@
470471
</ReturnValue>
471472
<Docs>
472473
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</summary>
473-
<value>To be added.</value>
474+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
474475
<remarks>
475476
<format type="text/markdown"><![CDATA[
476477
@@ -518,7 +519,7 @@
518519
<Parameters />
519520
<Docs>
520521
<summary>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</summary>
521-
<returns>To be added.</returns>
522+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
522523
<remarks>
523524
<format type="text/markdown"><![CDATA[
524525

xml/System.Drawing.Printing/PrinterSettings+StringCollection.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="PrinterSettings+StringCollection" FullName="System.Drawing.Printing.PrinterSettings+StringCollection">
1+
<Type Name="PrinterSettings+StringCollection" FullName="System.Drawing.Printing.PrinterSettings+StringCollection">
22
<TypeSignature Language="C#" Value="public class PrinterSettings.StringCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit PrinterSettings/StringCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Drawing.Printing.PrinterSettings.StringCollection" />
@@ -359,7 +359,7 @@
359359
</ReturnValue>
360360
<Docs>
361361
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.Count" />.</summary>
362-
<value>To be added.</value>
362+
<value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
363363
<remarks>
364364
<format type="text/markdown"><![CDATA[
365365
@@ -399,7 +399,8 @@
399399
</ReturnValue>
400400
<Docs>
401401
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.IsSynchronized" />.</summary>
402-
<value>To be added.</value>
402+
<value>
403+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
403404
<remarks>
404405
<format type="text/markdown"><![CDATA[
405406
@@ -439,7 +440,7 @@
439440
</ReturnValue>
440441
<Docs>
441442
<summary>For a description of this member, see <see cref="P:System.Collections.ICollection.SyncRoot" />.</summary>
442-
<value>To be added.</value>
443+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
443444
<remarks>
444445
<format type="text/markdown"><![CDATA[
445446
@@ -487,7 +488,7 @@
487488
<Parameters />
488489
<Docs>
489490
<summary>For a description of this member, see <see cref="M:System.Collections.IEnumerable.GetEnumerator" />.</summary>
490-
<returns>To be added.</returns>
491+
<returns>An enumerator that can be used to iterate through the collection.</returns>
491492
<remarks>
492493
<format type="text/markdown"><![CDATA[
493494

0 commit comments

Comments
 (0)