Skip to content

Restored enumeration member remarks, Part 9 #2646

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 2 commits into from
Jun 28, 2019
Merged

Restored enumeration member remarks, Part 9 #2646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75310bc
Restored enumeration member remarks, Part 9
Jun 26, 2019
076df88
Corrected misformred xml
Jun 27, 2019
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
12 changes: 2 additions & 10 deletions xml/System.Transactions/IsolationLevel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

The lowest isolation level, `ReadUncommitted`, allows many transactions to operate on a data store simultaneously and provides no protection against data corruption due to interruptive transactions. The highest isolation level, `Serializable`, provides a high degree of protection against interruptive transactions, but requires that each transaction complete before any other transactions are allowed to operate on the data.

The isolation level of a transaction is determined when the transaction is created. By default, the <xref:System.Transactions> infrastructure creates `Serializable` transactions. You can determine the isolation level of an existing transaction using the <xref:System.Transactions.Transaction.IsolationLevel%2A> property of a transaction.
The isolation level of a transaction is determined when the transaction is created. By default, the <xref:System.Transactions> infrastructure creates `Serializable` transactions. You can determine the isolation level of an existing transaction by using the <xref:System.Transactions.Transaction.IsolationLevel%2A?displayProperty=nameWithType> property of a transaction.

]]></format>
</remarks>
Expand Down Expand Up @@ -229,15 +229,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>Volatile data can be read. Before a transaction modifies data, it verifies if another transaction has changed the data after it was initially read. If the data has been updated, an error is raised. This allows a transaction to get to the previously committed value of the data.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
When you try to promote a transaction that was created with this isolation level, an <xref:System.InvalidOperationException> is thrown with the error message "Transactions with IsolationLevel Snapshot cannot be promoted".

]]></format>
</remarks>
<summary><para>Volatile data can be read. Before a transaction modifies data, it verifies if another transaction has changed the data after it was initially read. If the data has been updated, an error is raised. This allows a transaction to get to the previously committed value of the data.</para><para>When you try to promote a transaction that was created with the <see langword="Snapshot" /> isolation level, an <see cref="T:System.InvalidOperationException" /> is thrown with the error message "Transactions with IsolationLevel Snapshot cannot be promoted".</para></summary>
</Docs>
</Member>
<Member MemberName="Unspecified">
Expand Down
10 changes: 1 addition & 9 deletions xml/System.Transactions/TransactionScopeAsyncFlowOption.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Specifies that transaction flow across thread continuations is suppressed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
This is the default setting if no <xref:System.Transactions.TransactionScopeAsyncFlowOption> is specified in the <xref:System.Transactions.TransactionScope.%23ctor%2A> constructor.

]]></format>
</remarks>
<summary>Specifies that transaction flow across thread continuations is suppressed. This is the default setting if no <see langword="TransactionScopeAsyncFlowOption" /> is specified in the <see cref="Overload:System.Transactions.TransactionScope.#ctor" /> constructor.</summary>
</Docs>
</Member>
</Members>
Expand Down
86 changes: 9 additions & 77 deletions xml/System.Web.Configuration/MachineKeyValidation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@
## Remarks
ASP.NET uses a hash-based message authentication code (HMAC) to help detect whether data that is used for forms authentication or view state has been tampered with. The HMAC is generated when view state content is created, and the HMAC is checked on subsequent requests. The HMAC helps ASP.NET determine whether someone has changed data that is sent between the server and the client, but the data can be read by anyone as it travels through the Internet unless it is also encrypted. By default, view state is validated but not encrypted. For more information, see <xref:System.Web.UI.Page.ViewStateEncryptionMode%2A> and <xref:System.Web.UI.Page.RegisterRequiresViewStateEncryption%2A>.

The <xref:System.Web.Configuration.MachineKeyValidation> enumeration lets you specify the algorithm that ASP.NET uses to create the HMAC. The default value is HMACSHA256. ASP.NET uses the value of the <xref:System.Web.Configuration.MachineKeySection.ValidationKey%2A> property with the selected algorithm to generate the HMAC.


The `MachineKeyValidation` enumeration lets you specify the algorithm that ASP.NET uses to create the HMAC. The default value is `HMACSHA256`. ASP.NET uses the value of the <xref:System.Web.Configuration.MachineKeySection.ValidationKey%2A> property with the selected algorithm to generate the HMAC.

## Examples
The following code example shows how to use the <xref:System.Web.Configuration.MachineKeyValidation> enumeration. In the example, `configSection` is an instance of <xref:System.Web.Configuration.MachineKeySection>.This code example is part of a larger example provided for the <xref:System.Web.Configuration.MachineKeySection> class.
Expand Down Expand Up @@ -59,15 +57,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Specifies that ASP.NET uses the <see langword="AES" /> (Rijndael) encryption algorithm.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Choose this option if you want to encrypt view state in your Web application. If you choose this option, the <xref:System.Web.Configuration.MachineKeySection.DecryptionKey%2A> property will be used for encryption and decryption, and the `HMACSHA1` hash algorithm will be used with the <xref:System.Web.Configuration.MachineKeySection.ValidationKey%2A> property for validation.

]]></format>
</remarks>
<summary><para>Specifies that ASP.NET uses the <see langword="AES" /> (Rijndael) encryption algorithm. Choose this option if you want to encrypt view state in your Web application.</para><para>If you choose this option, the <see cref="P:System.Web.Configuration.MachineKeySection.DecryptionKey" /> property will be used for encryption and decryption, and the <see langword="HMACSHA1" /> hash algorithm will be used with the <see cref="P:System.Web.Configuration.MachineKeySection.ValidationKey" /> property for validation.</para></summary>
<altmember cref="T:System.Web.Configuration.MachineKeyValidation" />
</Docs>
</Member>
Expand All @@ -88,17 +78,7 @@
</ReturnValue>
<MemberValue>7</MemberValue>
<Docs>
<summary>Specifies that ASP.NET uses a custom hashing algorithm.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The custom hashing algorithm can be implemented in any class that derives from <xref:System.Security.Cryptography.KeyedHashAlgorithm>.

The custom algorithm is typically specified declaratively in the validation attribute of the element, in the format `alg:`*algorithm_name*. For information about how to specify a custom algorithm in code, see the <xref:System.Web.Configuration.MachineKeySection.ValidationAlgorithm%2A?displayProperty=nameWithType> property.

]]></format>
</remarks>
<summary><para>Specifies that ASP.NET uses a custom hashing algorithm. The custom hashing algorithm can be implemented in any class that derives from <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm" />.</para><para>The custom algorithm is typically specified declaratively in the <c>validation</c> attribute of the <see href="https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/w8h3skw9(v=vs.100)">machineKey</see> element, in the format <c>alg:`*algorithm_name*</c>. For information about how to specify a custom algorithm in code, see the <see cref="P:System.Web.Configuration.MachineKeySection.ValidationAlgorithm" /> property.</para></summary>
<altmember cref="T:System.Web.Configuration.MachineKeyValidation" />
</Docs>
</Member>
Expand All @@ -119,15 +99,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>Specifies that ASP.NET uses the <see langword="HMACSHA256" /> hashing algorithm. This is the default value.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
`HMACSHA256` is an SHA2 hashing algorithm that generates a 256-bit hash code.

]]></format>
</remarks>
<summary>Specifies that ASP.NET uses the <see langword="HMACSHA256" /> hashing algorithm, which is an SHA2 hashing algorithm that generates a 256-bit hash code. This is the default value.</summary>
<altmember cref="T:System.Web.Configuration.MachineKeyValidation" />
</Docs>
</Member>
Expand All @@ -148,15 +120,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>Specifies that ASP.NET uses the <see langword="HMACSHA384" /> hashing algorithm.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
`HMACSHA384` is an SHA2 hashing algorithm that generates a 384-bit hash code. This option is available for applications that require stronger security than is provided by the `HMACSHA256` algorithm.

]]></format>
</remarks>
<summary>Specifies that ASP.NET uses the <see langword="HMACSHA384" /> hashing algorithm, which is an SHA2 hashing algorithm that generates a 384-bit hash code. This option is available for applications that require stronger security than provided by the <see langword="HMACSHA256" /> algorithm..</summary>
<altmember cref="T:System.Web.Configuration.MachineKeyValidation" />
</Docs>
</Member>
Expand All @@ -177,15 +141,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>Specifies that ASP.NET uses the <see langword="HMACSHA512" /> hashing algorithm.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
`HMACSHA512` is an SHA2 hashing algorithm that generates a 512-bit hash code. This option is available for applications that require stronger security than is provided by the `HMACSHA384` algorithm.

]]></format>
</remarks>
<summary>Specifies that ASP.NET uses the <see langword="HMACSHA512" /> hashing algorithm, which is an SHA2 hashing algorithm that generates a 512-bit hash code. This option is available for applications that require stronger security than provided by the <see langword=">HMACSHA384" /> algorithm.</summary>
<altmember cref="T:System.Web.Configuration.MachineKeyValidation" />
</Docs>
</Member>
Expand All @@ -207,15 +163,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Specifies that ASP.NET uses the Message Digest 5 (<see langword="MD5" />) hashing algorithm.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
`MD5` is a hashing algorithm that generates a 128-bit hash value. This option is included for legacy purposes and should be selected only if compatibility with earlier versions of ASP.NET is required.

]]></format>
</remarks>
<summary>Specifies that ASP.NET uses the Message Digest 5 (<see langword="MD5" />) hashing algorithm, which is a hashing algorithm that generates a 128-bit hash value. This is a legacy value that should be selected only if compatibility with earlier versions of ASP.NET is required.</summary>
<altmember cref="T:System.Web.Configuration.MachineKeyValidation" />
</Docs>
</Member>
Expand All @@ -237,15 +185,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Specifies that ASP.NET uses the <see langword="HMACSHA1" /> hash algorithm.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
`HMACSHA1` is a hashing algorithm that generates a 160-bit hash value. This option is included for legacy purposes and should be selected only if compatibility with earlier versions of ASP.NET is required.

]]></format>
</remarks>
<summary>Specifies that ASP.NET uses the <see langword="HMACSHA1" /> hash algorithm, which is a hashing algorithm that generates a 160-bit hash value. This is a legacy value that should be selected only if compatibility with earlier versions of ASP.NET is required.</summary>
<altmember cref="T:System.Web.Configuration.MachineKeyValidation" />
</Docs>
</Member>
Expand All @@ -267,15 +207,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Specifies that ASP.NET uses the TripleDES (<see langword="3DES" />) encryption algorithm.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
TripleDES is an encryption algorithm that is used only if you specify that view state is encrypted. This option is included for legacy purposes and should be selected only if compatibility with earlier versions of ASP.NET is required.

]]></format>
</remarks>
<summary>Specifies that ASP.NET uses the TripleDES (<see langword="3DES" />) encryption algorithm, which is an encryption algorithm that is used only if you specify that view state is encrypted. This is a legacy value that should be selected only if compatibility with earlier versions of ASP.NET is required..</summary>
<altmember cref="T:System.Web.Configuration.MachineKeyValidation" />
</Docs>
</Member>
Expand Down
67 changes: 9 additions & 58 deletions xml/System.Web.Configuration/ProcessModelComAuthenticationLevel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Web.Configuration.ProcessModelComAuthenticationLevel> enumerates the values to use when you set the <xref:System.Web.Configuration.ProcessModelSection.ComAuthenticationLevel%2A> property.

`ProcessModelComAuthenticationLevel` defines the values to use when you set the <xref:System.Web.Configuration.ProcessModelSection.ComAuthenticationLevel%2A?displayProperty=nameWithType> property.

The default is Connect.
The default is `Connect`.

> [!NOTE]
> The <xref:System.Web.Configuration.ProcessModelComAuthenticationLevel.Connect> settings are relevant only when you use the ASP.NET process model (Internet Information Services [IIS] 5.n or compatible mode on IIS 6 only).
Expand Down Expand Up @@ -57,15 +58,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Specifies that DCOM authenticates the credentials of the client. This field is constant.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
DCOM authenticates the credentials of the client when the server receives the request at the beginning of each remote procedure call.

]]></format>
</remarks>
<summary>Specifies that DCOM authenticates the credentials of the client when the server receives the request at the beginning of each remote procedure call.</summary>
</Docs>
</Member>
<Member MemberName="Connect">
Expand All @@ -86,17 +79,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Specifies that DCOM authenticates the credentials of the client. This field is constant.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
DCOM authenticates the credentials of the client only when the client establishes a relationship with the server.

This is the default value.

]]></format>
</remarks>
<summary>Specifies that DCOM authenticates the credentials of the client only when the client establishes a relationship with the server. This is the default value. </summary>
</Docs>
</Member>
<Member MemberName="Default">
Expand All @@ -117,15 +100,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Specifies that DCOM determines the authentication level. This field is constant.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
DCOM determines the authentication level using its normal security-negotiation algorithm.

]]></format>
</remarks>
<summary>Specifies that DCOM determines the authentication level using its normal security-negotiation algorithm.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand Down Expand Up @@ -167,15 +142,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>Specifies that DCOM verifies that all data received is from the expected client. This field is constant.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The datagram transports always use Pkt authentication.

]]></format>
</remarks>
<summary>Specifies that DCOM verifies that all data received is from the expected client. The datagram transports always use Pkt authentication.</summary>
</Docs>
</Member>
<Member MemberName="PktIntegrity">
Expand All @@ -196,15 +163,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>Specifies that DCOM authenticates and verifies the data transferred. This field is constant.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
DCOM verifies that none of the data transferred between the client and the server has been modified.

]]></format>
</remarks>
<summary>Specifies that DCOM authenticates and verifies that none of the data transferred between the client and the server has been modified.</summary>
</Docs>
</Member>
<Member MemberName="PktPrivacy">
Expand All @@ -225,15 +184,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>Specifies that DCOM authenticates all previous levels and does encryption. This field is constant.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
DCOM authenticates all previous levels and encrypts the argument value of each remote procedure call.

]]></format>
</remarks>
<summary>Specifies that DCOM authenticates all previous levels and encrypts the argument value of each remote procedure call.</summary>
</Docs>
</Member>
</Members>
Expand Down
Loading