Skip to content

Commit

Permalink
Automatic port of System.Data.Common docs (dotnet#4885)
Browse files Browse the repository at this point in the history 
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
  • Loading branch information
@carlossanlop @gewarren
2 people authored and gewarren committed Sep 24, 2020
1 parent 25a02ac commit 1c0cd17
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions xml/System.Data.Common/DbTransaction.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -507,8 +507,8 @@
<Parameter Name="savepointName" Type="System.String" Index="0" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="savepointName">To be added.</param>
<summary>To be added.</summary>
<param name="savepointName">The name of the savepoint to release.</param>
<summary>Destroys a savepoint previously defined in the current transaction. This allows the system to reclaim some resources before the transaction ends.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -534,10 +534,10 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="savepointName">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="savepointName">The name of the savepoint to release.</param>
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Destroys a savepoint previously defined in the current transaction. This allows the system to reclaim some resources before the transaction ends.</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -605,8 +605,8 @@
<Parameter Name="savepointName" Type="System.String" Index="0" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="savepointName">To be added.</param>
<summary>To be added.</summary>
<param name="savepointName">The name of the savepoint to roll back to.</param>
<summary>Rolls back all commands that were executed after the specified savepoint was established.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -674,10 +674,10 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="savepointName">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="savepointName">The name of the savepoint to roll back to.</param>
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Rolls back all commands that were executed after the specified savepoint was established.</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -703,8 +703,8 @@
<Parameter Name="savepointName" Type="System.String" Index="0" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="savepointName">To be added.</param>
<summary>To be added.</summary>
<param name="savepointName">The name of the savepoint to be created.</param>
<summary>Creates a savepoint in the transaction. This allows all commands that are executed after the savepoint was established to be rolled back, restoring the transaction state to what it was at the time of the savepoint.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -730,10 +730,10 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="savepointName">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="savepointName">The name of the savepoint to be created.</param>
<param name="cancellationToken">An optional token to cancel the asynchronous operation. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Creates a savepoint in the transaction. This allows all commands that are executed after the savepoint was established to be rolled back, restoring the transaction state to what it was at the time of the savepoint.</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -756,8 +756,10 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether this <see cref="T:System.Data.Common.DbTransaction" /> instance supports database savepoints.
If <see langword="false" />, the methods <see cref="M:System.Data.Common.DbTransaction.SaveAsync(System.String,System.Threading.CancellationToken)" />, <see cref="M:System.Data.Common.DbTransaction.RollbackAsync(System.String,System.Threading.CancellationToken)" /> and <see cref="M:System.Data.Common.DbTransaction.ReleaseAsync(System.String,System.Threading.CancellationToken)" /> as well as their synchronous counterparts are expected to throw <see cref="T:System.NotSupportedException" />.</summary>
<value>
<see langword="true" /> if this <see cref="T:System.Data.Common.DbTransaction" /> instance supports database savepoints; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down

0 comments on commit 1c0cd17

Please sign in to comment.