Skip to content

Commit 2dbfa9d

Browse files
gewarrengewarren
authored
Move enum remarks to summary (part 1) (dotnet#5269)
1 parent 9cbd349 commit 2dbfa9d

File tree

14 files changed

+84
-302
lines changed

14 files changed

+84
-302
lines changed

‎xml/Microsoft.Extensions.DependencyInjection/ServiceLifetime.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@
4848
</ReturnValue>
4949
<MemberValue>1</MemberValue>
5050
<Docs>
51-
<summary>Specifies that a new instance of the service will be created for each scope.</summary>
52-
<remarks>In ASP.NET Core applications a scope is created around each server request.</remarks>
51+
<summary>Specifies that a new instance of the service will be created for each scope. In ASP.NET Core apps, a scope is created around each server request.</summary>
5352
</Docs>
5453
</Member>
5554
<Member MemberName="Singleton">

‎xml/Microsoft.Extensions.Logging.Console/LoggerColorBehavior.xml

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,10 @@
3434
</ReturnValue>
3535
<MemberValue>0</MemberValue>
3636
<Docs>
37-
<summary>Use the default color behavior, enabling color except when the console output is redirected.</summary>
38-
<remarks>
39-
<format type="text/markdown"><![CDATA[
40-
41-
## Remarks
42-
43-
Enables color except when the console output is redirected.
44-
45-
]]></format>
46-
</remarks>
37+
<summary>
38+
<para>Use the default color behavior.</para>
39+
<para>Color is not enabled when the console output is redirected.</para>
40+
</summary>
4741
</Docs>
4842
</Member>
4943
<Member MemberName="Disabled">

‎xml/Mono.Security.Interface/HashAlgorithmType.xml

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>To be added.</summary>
16+
<summary>Specifies the hashing algorithms for a <see cref="T:Mono.Security.Interface.MonoTlsConnectionInfo" /> instance.</summary>
1717
<remarks>To be added.</remarks>
1818
</Docs>
1919
<Members>
@@ -34,8 +34,7 @@
3434
</ReturnValue>
3535
<MemberValue>1</MemberValue>
3636
<Docs>
37-
<summary>To be added.</summary>
38-
<remarks>Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</remarks>
37+
<summary>The Message Digest 5 (MD5) hashing algorithm. Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</summary>
3938
</Docs>
4039
</Member>
4140
<Member MemberName="Md5Sha1">
@@ -55,8 +54,7 @@
5554
</ReturnValue>
5655
<MemberValue>254</MemberValue>
5756
<Docs>
58-
<summary>To be added.</summary>
59-
<remarks>Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</remarks>
57+
<summary>The MD5 and SHA1 algorithms. Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</summary>
6058
</Docs>
6159
</Member>
6260
<Member MemberName="None">
@@ -76,7 +74,7 @@
7674
</ReturnValue>
7775
<MemberValue>0</MemberValue>
7876
<Docs>
79-
<summary>To be added.</summary>
77+
<summary>No hashing algorithm is used.</summary>
8078
</Docs>
8179
</Member>
8280
<Member MemberName="Sha1">
@@ -96,8 +94,7 @@
9694
</ReturnValue>
9795
<MemberValue>2</MemberValue>
9896
<Docs>
99-
<summary>To be added.</summary>
100-
<remarks>Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</remarks>
97+
<summary>The Secure Hashing Algorithm (SHA1). Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</summary>
10198
</Docs>
10299
</Member>
103100
<Member MemberName="Sha224">
@@ -117,7 +114,7 @@
117114
</ReturnValue>
118115
<MemberValue>3</MemberValue>
119116
<Docs>
120-
<summary>To be added.</summary>
117+
<summary>The Secure Hashing Algorithm 2 (SHA-2), using a 224-bit digest.</summary>
121118
</Docs>
122119
</Member>
123120
<Member MemberName="Sha256">
@@ -137,7 +134,7 @@
137134
</ReturnValue>
138135
<MemberValue>4</MemberValue>
139136
<Docs>
140-
<summary>To be added.</summary>
137+
<summary>The Secure Hashing Algorithm 2 (SHA-2), using a 256-bit digest.</summary>
141138
</Docs>
142139
</Member>
143140
<Member MemberName="Sha384">
@@ -157,7 +154,7 @@
157154
</ReturnValue>
158155
<MemberValue>5</MemberValue>
159156
<Docs>
160-
<summary>To be added.</summary>
157+
<summary>The Secure Hashing Algorithm 2 (SHA-2), using a 384-bit digest.</summary>
161158
</Docs>
162159
</Member>
163160
<Member MemberName="Sha512">
@@ -177,7 +174,7 @@
177174
</ReturnValue>
178175
<MemberValue>6</MemberValue>
179176
<Docs>
180-
<summary>To be added.</summary>
177+
<summary>The Secure Hashing Algorithm 2 (SHA-2), using a 512-bit digest.</summary>
181178
</Docs>
182179
</Member>
183180
<Member MemberName="Unknown">
@@ -197,7 +194,7 @@
197194
</ReturnValue>
198195
<MemberValue>255</MemberValue>
199196
<Docs>
200-
<summary>To be added.</summary>
197+
<summary>The hashing algorithm is unknown.</summary>
201198
</Docs>
202199
</Member>
203200
</Members>

‎xml/System.Activities/ActivityInstanceState.xml

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
<MemberValue>2</MemberValue>
4848
<Docs>
4949
<summary>
50-
<para>Specifies that the activity is in a canceled state.</para>
51-
<para>Canceled is a terminal state for an activity instance. A Canceled activity completes without performing the function it was designed to perform.</para>
50+
<para>The canceled state.</para>
51+
<para><see cref="F:System.Activities.ActivityInstanceState.Canceled" /> is a terminal state for an activity instance. A <see cref="F:System.Activities.ActivityInstanceState.Canceled" /> activity completes without performing the function it was designed to perform.</para>
5252
</summary>
5353
</Docs>
5454
</Member>
@@ -76,8 +76,8 @@
7676
<MemberValue>1</MemberValue>
7777
<Docs>
7878
<summary>
79-
<para>Specifies that the activity is in a closed state.</para>
80-
<para>Closed is a terminal state for an activity instance. A Closed activity completed successfully and performed the function it was designed to perform.</para>
79+
<para>The closed state.</para>
80+
<para><see cref="F:System.Activities.ActivityInstanceState.Closed" /> is a terminal state for an activity instance. A <see cref="F:System.Activities.ActivityInstanceState.Closed" /> activity completed successfully and performed the function it was designed to perform.</para>
8181
</summary>
8282
</Docs>
8383
</Member>
@@ -104,7 +104,7 @@
104104
</ReturnValue>
105105
<MemberValue>0</MemberValue>
106106
<Docs>
107-
<summary>Specifies that the activity is in an executing state.</summary>
107+
<summary>The executing state.</summary>
108108
</Docs>
109109
</Member>
110110
<Member MemberName="Faulted">
@@ -130,15 +130,10 @@
130130
</ReturnValue>
131131
<MemberValue>3</MemberValue>
132132
<Docs>
133-
<summary>Specifies that the activity is in a faulted state.</summary>
134-
<remarks>
135-
<format type="text/markdown"><![CDATA[
136-
137-
## Remarks
138-
Faulted is a terminal state for an activity instance. A Faulted activity instance was aborted during execution, potentially because of an exception, and did not perform the function it was designed to perform.
139-
140-
]]></format>
141-
</remarks>
133+
<summary>
134+
<para>The faulted state.</para>
135+
<para><see cref="F:System.Activities.ActivityInstanceState.Faulted" /> is a terminal state for an activity instance. A <see cref="F:System.Activities.ActivityInstanceState.Faulted" /> activity instance was aborted during execution, potentially because of an exception, and did not perform the function it was designed to perform.</para>
136+
</summary>
142137
</Docs>
143138
</Member>
144139
</Members>

‎xml/System.Drawing.Imaging/EncoderParameterValueType.xml

Lines changed: 7 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,7 @@
6464
</ReturnValue>
6565
<MemberValue>2</MemberValue>
6666
<Docs>
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>
67+
<summary>An 8-bit ASCII value. This field specifies that the array of values is a null-terminated ASCII character string.</summary>
7768
</Docs>
7869
</Member>
7970
<Member MemberName="ValueTypeByte">
@@ -104,7 +95,6 @@ The <see langword="NumberOfValues" /> data member of the <see cref="T:System.Dra
10495
<MemberValue>1</MemberValue>
10596
<Docs>
10697
<summary>An 8-bit unsigned integer.</summary>
107-
<remarks>To be added.</remarks>
10898
</Docs>
10999
</Member>
110100
<Member MemberName="ValueTypeLong">
@@ -135,7 +125,6 @@ The <see langword="NumberOfValues" /> data member of the <see cref="T:System.Dra
135125
<MemberValue>4</MemberValue>
136126
<Docs>
137127
<summary>A 32-bit unsigned integer.</summary>
138-
<remarks>To be added.</remarks>
139128
</Docs>
140129
</Member>
141130
<Member MemberName="ValueTypeLongRange">
@@ -165,15 +154,7 @@ The <see langword="NumberOfValues" /> data member of the <see cref="T:System.Dra
165154
</ReturnValue>
166155
<MemberValue>6</MemberValue>
167156
<Docs>
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>
157+
<summary>Two long values that specify a range of integer values. The first value specifies the lower end, and the second value specifies the higher end. All values are inclusive at both ends.</summary>
177158
</Docs>
178159
</Member>
179160
<Member MemberName="ValueTypePointer">
@@ -194,7 +175,6 @@ The first value specifies the lower end, and the second value specifies the high
194175
<MemberValue>9</MemberValue>
195176
<Docs>
196177
<summary>A pointer to a block of custom metadata.</summary>
197-
<remarks>To be added.</remarks>
198178
</Docs>
199179
</Member>
200180
<Member MemberName="ValueTypeRational">
@@ -225,7 +205,6 @@ The first value specifies the lower end, and the second value specifies the high
225205
<MemberValue>5</MemberValue>
226206
<Docs>
227207
<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>
229208
</Docs>
230209
</Member>
231210
<Member MemberName="ValueTypeRationalRange">
@@ -255,17 +234,10 @@ The first value specifies the lower end, and the second value specifies the high
255234
</ReturnValue>
256235
<MemberValue>8</MemberValue>
257236
<Docs>
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>
237+
<summary>
238+
<para>A set of four 32-bit unsigned integers. The first two integers represent one fraction, and the second two integers represent a second fraction.</para>
239+
<para>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.</para>
240+
</summary>
269241
</Docs>
270242
</Member>
271243
<Member MemberName="ValueTypeShort">
@@ -296,7 +268,6 @@ The values are inclusive at both ends.
296268
<MemberValue>3</MemberValue>
297269
<Docs>
298270
<summary>A 16-bit, unsigned integer.</summary>
299-
<remarks>To be added.</remarks>
300271
</Docs>
301272
</Member>
302273
<Member MemberName="ValueTypeUndefined">
@@ -326,15 +297,7 @@ The values are inclusive at both ends.
326297
</ReturnValue>
327298
<MemberValue>7</MemberValue>
328299
<Docs>
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>
300+
<summary>A byte that has no data type defined. The variable can take any value depending on field definition.</summary>
338301
</Docs>
339302
</Member>
340303
</Members>

0 commit comments

Comments
 (0)