Skip to content

Move enum remarks to summary (part 1) #5269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 22, 2021
Merged

Move enum remarks to summary (part 1) #5269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
63efae5
convert enum field remarks
gewarren Jan 21, 2021
d405c4f
convert enum remarks
gewarren Jan 21, 2021
e88480b
break into paragraphs
gewarren Jan 21, 2021
833cf59
fix build warnings
gewarren Jan 21, 2021
9b10212
fix build error
gewarren Jan 21, 2021
da3a2c7
code formatting
gewarren Jan 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions xml/Microsoft.Extensions.DependencyInjection/ServiceLifetime.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Specifies that a new instance of the service will be created for each scope.</summary>
<remarks>In ASP.NET Core applications a scope is created around each server request.</remarks>
<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>
</Docs>
</Member>
<Member MemberName="Singleton">
Expand Down
14 changes: 4 additions & 10 deletions xml/Microsoft.Extensions.Logging.Console/LoggerColorBehavior.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,10 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Use the default color behavior, enabling color except when the console output is redirected.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Enables color except when the console output is redirected.

]]></format>
</remarks>
<summary>
<para>Use the default color behavior.</para>
<para>Color is not enabled when the console output is redirected.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Disabled">
Expand Down
23 changes: 10 additions & 13 deletions xml/Mono.Security.Interface/HashAlgorithmType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<summary>Specifies the hashing algorithms for a <see cref="T:Mono.Security.Interface.MonoTlsConnectionInfo" /> instance.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,8 +34,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<remarks>Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</remarks>
<summary>The Message Digest 5 (MD5) hashing algorithm. Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</summary>
</Docs>
</Member>
<Member MemberName="Md5Sha1">
Expand All @@ -55,8 +54,7 @@
</ReturnValue>
<MemberValue>254</MemberValue>
<Docs>
<summary>To be added.</summary>
<remarks>Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</remarks>
<summary>The MD5 and SHA1 algorithms. Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand All @@ -76,7 +74,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>No hashing algorithm is used.</summary>
</Docs>
</Member>
<Member MemberName="Sha1">
Expand All @@ -96,8 +94,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<remarks>Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</remarks>
<summary>The Secure Hashing Algorithm (SHA1). Due to collision problems with SHA1, Microsoft recommends SHA256 or better.</summary>
</Docs>
</Member>
<Member MemberName="Sha224">
Expand All @@ -117,7 +114,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The Secure Hashing Algorithm 2 (SHA-2), using a 224-bit digest.</summary>
</Docs>
</Member>
<Member MemberName="Sha256">
Expand All @@ -137,7 +134,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The Secure Hashing Algorithm 2 (SHA-2), using a 256-bit digest.</summary>
</Docs>
</Member>
<Member MemberName="Sha384">
Expand All @@ -157,7 +154,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The Secure Hashing Algorithm 2 (SHA-2), using a 384-bit digest.</summary>
</Docs>
</Member>
<Member MemberName="Sha512">
Expand All @@ -177,7 +174,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The Secure Hashing Algorithm 2 (SHA-2), using a 512-bit digest.</summary>
</Docs>
</Member>
<Member MemberName="Unknown">
Expand All @@ -197,7 +194,7 @@
</ReturnValue>
<MemberValue>255</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The hashing algorithm is unknown.</summary>
</Docs>
</Member>
</Members>
Expand Down
23 changes: 9 additions & 14 deletions xml/System.Activities/ActivityInstanceState.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@
<MemberValue>2</MemberValue>
<Docs>
<summary>
<para>Specifies that the activity is in a canceled state.</para>
<para>Canceled is a terminal state for an activity instance. A Canceled activity completes without performing the function it was designed to perform.</para>
<para>The canceled state.</para>
<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>
</summary>
</Docs>
</Member>
Expand Down Expand Up @@ -76,8 +76,8 @@
<MemberValue>1</MemberValue>
<Docs>
<summary>
<para>Specifies that the activity is in a closed state.</para>
<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>
<para>The closed state.</para>
<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>
</summary>
</Docs>
</Member>
Expand All @@ -104,7 +104,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Specifies that the activity is in an executing state.</summary>
<summary>The executing state.</summary>
</Docs>
</Member>
<Member MemberName="Faulted">
Expand All @@ -130,15 +130,10 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Specifies that the activity is in a faulted state.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

]]></format>
</remarks>
<summary>
<para>The faulted state.</para>
<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>
</summary>
</Docs>
</Member>
</Members>
Expand Down
51 changes: 7 additions & 44 deletions xml/System.Drawing.Imaging/EncoderParameterValueType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<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>
<summary>An 8-bit ASCII value. This field specifies that the array of values is a null-terminated ASCII character string.</summary>
</Docs>
</Member>
<Member MemberName="ValueTypeByte">
Expand Down Expand Up @@ -104,7 +95,6 @@ The <see langword="NumberOfValues" /> data member of the <see cref="T:System.Dra
<MemberValue>1</MemberValue>
<Docs>
<summary>An 8-bit unsigned integer.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValueTypeLong">
Expand Down Expand Up @@ -135,7 +125,6 @@ The <see langword="NumberOfValues" /> data member of the <see cref="T:System.Dra
<MemberValue>4</MemberValue>
<Docs>
<summary>A 32-bit unsigned integer.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValueTypeLongRange">
Expand Down Expand Up @@ -165,15 +154,7 @@ The <see langword="NumberOfValues" /> data member of the <see cref="T:System.Dra
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<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>
<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>
</Docs>
</Member>
<Member MemberName="ValueTypePointer">
Expand All @@ -194,7 +175,6 @@ The first value specifies the lower end, and the second value specifies the high
<MemberValue>9</MemberValue>
<Docs>
<summary>A pointer to a block of custom metadata.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValueTypeRational">
Expand Down Expand Up @@ -225,7 +205,6 @@ The first value specifies the lower end, and the second value specifies the high
<MemberValue>5</MemberValue>
<Docs>
<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">
Expand Down Expand Up @@ -255,17 +234,10 @@ The first value specifies the lower end, and the second value specifies the high
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<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>
<summary>
<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>
<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>
</summary>
</Docs>
</Member>
<Member MemberName="ValueTypeShort">
Expand Down Expand Up @@ -296,7 +268,6 @@ The values are inclusive at both ends.
<MemberValue>3</MemberValue>
<Docs>
<summary>A 16-bit, unsigned integer.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValueTypeUndefined">
Expand Down Expand Up @@ -326,15 +297,7 @@ The values are inclusive at both ends.
</ReturnValue>
<MemberValue>7</MemberValue>
<Docs>
<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>
<summary>A byte that has no data type defined. The variable can take any value depending on field definition.</summary>
</Docs>
</Member>
</Members>
Expand Down
Loading