Skip to content

Commit 3b68e97

Browse files
marcwrobelsbrannen
authored andcommitted
Fix and improve Javadoc in spring-tx
Closes gh-28794
1 parent 6f494ef commit 3b68e97

21 files changed

+25
-25
lines changed

spring-tx/src/main/java/org/springframework/dao/CleanupFailureDataAccessException.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@
1717
package org.springframework.dao;
1818

1919
/**
20-
* Exception thrown when we couldn't cleanup after a data access operation,
20+
* Exception thrown when we couldn't clean up after a data access operation,
2121
* but the actual operation went OK.
2222
*
2323
* <p>For example, this exception or a subclass might be thrown if a JDBC
2424
* Connection couldn't be closed after it had been used successfully.
2525
*
2626
* <p>Note that data access code might perform resources cleanup in a
27-
* finally block and therefore log cleanup failure rather than rethrow it,
27+
* {@code finally} block and therefore log cleanup failure rather than rethrow it,
2828
* to keep the original data access exception, if any.
2929
*
3030
* @author Rod Johnson

spring-tx/src/main/java/org/springframework/dao/DataAccessException.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
*
2828
* <p>This exception hierarchy aims to let user code find and handle the
2929
* kind of error encountered without knowing the details of the particular
30-
* data access API in use (e.g. JDBC). Thus it is possible to react to an
30+
* data access API in use (e.g. JDBC). Thus, it is possible to react to an
3131
* optimistic locking failure without knowing that JDBC is being used.
3232
*
3333
* <p>As this class is a runtime exception, there is no need for user code
@@ -50,7 +50,7 @@ public DataAccessException(String msg) {
5050
/**
5151
* Constructor for DataAccessException.
5252
* @param msg the detail message
53-
* @param cause the root cause (usually from using a underlying
53+
* @param cause the root cause (usually from using an underlying
5454
* data access API such as JDBC)
5555
*/
5656
public DataAccessException(@Nullable String msg, @Nullable Throwable cause) {

spring-tx/src/main/java/org/springframework/dao/DuplicateKeyException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
/**
2020
* Exception thrown when an attempt to insert or update data
21-
* results in violation of an primary key or unique constraint.
21+
* results in violation of a primary key or unique constraint.
2222
* Note that this is not necessarily a purely relational concept;
2323
* unique primary keys are required by most database types.
2424
*

spring-tx/src/main/java/org/springframework/dao/NonTransientDataAccessException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public NonTransientDataAccessException(String msg) {
4141
/**
4242
* Constructor for NonTransientDataAccessException.
4343
* @param msg the detail message
44-
* @param cause the root cause (usually from using a underlying
44+
* @param cause the root cause (usually from using an underlying
4545
* data access API such as JDBC)
4646
*/
4747
public NonTransientDataAccessException(@Nullable String msg, @Nullable Throwable cause) {

spring-tx/src/main/java/org/springframework/dao/RecoverableDataAccessException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public RecoverableDataAccessException(String msg) {
4141
/**
4242
* Constructor for RecoverableDataAccessException.
4343
* @param msg the detail message
44-
* @param cause the root cause (usually from using a underlying
44+
* @param cause the root cause (usually from using an underlying
4545
* data access API such as JDBC)
4646
*/
4747
public RecoverableDataAccessException(String msg, Throwable cause) {

spring-tx/src/main/java/org/springframework/dao/TransientDataAccessException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public TransientDataAccessException(String msg) {
4141
/**
4242
* Constructor for TransientDataAccessException.
4343
* @param msg the detail message
44-
* @param cause the root cause (usually from using a underlying
44+
* @param cause the root cause (usually from using an underlying
4545
* data access API such as JDBC)
4646
*/
4747
public TransientDataAccessException(String msg, @Nullable Throwable cause) {

spring-tx/src/main/java/org/springframework/dao/support/PersistenceExceptionTranslationInterceptor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ public void setPersistenceExceptionTranslator(PersistenceExceptionTranslator pet
9999
* raw exception when declared, i.e. when the originating method signature's exception
100100
* declarations allow for the raw exception to be thrown ("false").
101101
* <p>Default is "false". Switch this flag to "true" in order to always translate
102-
* applicable exceptions, independent from the originating method signature.
102+
* applicable exceptions, independent of the originating method signature.
103103
* <p>Note that the originating method does not have to declare the specific exception.
104104
* Any base class will do as well, even {@code throws Exception}: As long as the
105105
* originating method does explicitly declare compatible exceptions, the raw exception

spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* {@link javax.resource.spi.endpoint.MessageEndpointFactory} interface,
3636
* providing transaction management capabilities for any kind of message
3737
* listener object (e.g. {@link javax.jms.MessageListener} objects or
38-
* {@link javax.resource.cci.MessageListener} objects.
38+
* {@link javax.resource.cci.MessageListener} objects).
3939
*
4040
* <p>Uses AOP proxies for concrete endpoint instances, simply wrapping
4141
* the specified message listener object and exposing all of its implemented

spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointManager.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,9 @@ public boolean isAutoStartup() {
240240
/**
241241
* Specify the phase in which this endpoint manager should be started
242242
* and stopped. The startup order proceeds from lowest to highest, and
243-
* the shutdown order is the reverse of that. By default this value is
244-
* Integer.MAX_VALUE meaning that this endpoint manager starts as late
245-
* as possible and stops as soon as possible.
243+
* the shutdown order is the reverse of that. By default, this value is
244+
* {@code Integer.MAX_VALUE} meaning that this endpoint manager starts
245+
* as late as possible and stops as soon as possible.
246246
*/
247247
public void setPhase(int phase) {
248248
this.phase = phase;

spring-tx/src/main/java/org/springframework/transaction/SavepointManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* else, a subtransaction with PROPAGATION_NESTED is preferable.
2727
*
2828
* <p>This interface is inspired by JDBC 3.0's Savepoint mechanism
29-
* but is independent from any specific persistence technology.
29+
* but is independent of any specific persistence technology.
3030
*
3131
* @author Juergen Hoeller
3232
* @since 1.1

0 commit comments

Comments
 (0)