Skip to content

Commit 762a1bf

Browse files
author
nathan.xu
committed
improve some JDBC related Javadocs
1 parent a99628a commit 762a1bf

File tree

44 files changed

+62
-56
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+62
-56
lines changed

hibernate-core/src/main/java/org/hibernate/engine/jdbc/AbstractLobCreator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import java.sql.NClob;
99

1010
/**
11-
* Convenient base class for proxy-based LobCreator for handling wrapping.
11+
* Convenient base class for proxy-based {@link LobCreator} for handling wrapping.
1212
*
1313
* @author Steve Ebersole
1414
*/

hibernate-core/src/main/java/org/hibernate/engine/jdbc/BlobImplementer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import java.sql.SQLException;
88

99
/**
10-
* Marker interface for non-contextually created {@link java.sql.Blob} instances..
10+
* Marker interface for non-contextually created {@link java.sql.Blob} instances.
1111
*
1212
* @author Steve Ebersole
1313
*/

hibernate-core/src/main/java/org/hibernate/engine/jdbc/ClobImplementer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
package org.hibernate.engine.jdbc;
66

77
/**
8-
* Marker interface for non-contextually created {@link java.sql.Clob} instances..
8+
* Marker interface for non-contextually created {@link java.sql.Clob} instances.
99
*
1010
* @author Steve Ebersole
1111
*/

hibernate-core/src/main/java/org/hibernate/engine/jdbc/NClobImplementer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
package org.hibernate.engine.jdbc;
66

77
/**
8-
* Marker interface for non-contextually created java.sql.NClob instances..
8+
* Marker interface for non-contextually created {@link java.sql.NClob} instances.
99
* <p>
10-
* java.sql.NClob is a new type introduced in JDK 1.6 (JDBC 4)
10+
* {@link java.sql.NClob} is a new type introduced in JDK 1.6 (JDBC 4)
1111
*
1212
* @author Steve Ebersole
1313
*/

hibernate-core/src/main/java/org/hibernate/engine/jdbc/NonContextualLobCreator.java

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

1313
/**
1414
* {@link LobCreator} implementation using non-contextual or local creation, meaning that we generate the LOB
15-
* references ourselves as opposed to delegating to the JDBC {@link java.sql.Connection}.
15+
* references ourselves as opposed to delegating to the {@linkplain java.sql.Connection JDBC connection}.
1616
*
1717
* @author Steve Ebersole
1818
* @author Gail Badner

hibernate-core/src/main/java/org/hibernate/engine/jdbc/SerializableNClobProxy.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
import java.sql.NClob;
1010

1111
/**
12-
* Manages aspects of proxying java.sql.NClobs to add serializability.
12+
* Manages aspects of proxying {@link NClob}s to add serializability.
1313
*
1414
* @author Steve Ebersole
1515
*/

hibernate-core/src/main/java/org/hibernate/engine/jdbc/Size.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99
import java.io.Serializable;
1010

1111
/**
12-
* Models size restrictions/requirements on a column's datatype.
12+
* Models size restrictions/requirements on a column's data type.
1313
*
14-
* @implNote Since we do not necessarily know the datatype up front, and therefore do not necessarily know
14+
* @implNote Since we do not necessarily know the data type up front, and therefore do not necessarily know
1515
* whether length or precision/scale sizing is needed, we simply account for both here. Additionally, LOB
16-
* sizes, by standard, are allowed a "multiplier", {@code K} (Kb), {@code M} (Mb) or {@code G} (Gb).
16+
* sizes, by standard, are allowed a "multiplier", i.e., {@code K} (Kb), {@code M} (Mb) or {@code G} (Gb).
1717
*
1818
* @author Steve Ebersole
1919
*/

hibernate-core/src/main/java/org/hibernate/engine/jdbc/batch/internal/BasicBatchKey.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import org.hibernate.jdbc.Expectations;
99

1010
/**
11-
* Normal implementation of BatchKey
11+
* Normal implementation of {@link BatchKey}
1212
*
1313
* @author Steve Ebersole
1414
*/

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DatabaseConnectionInfoImpl.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import static org.hibernate.internal.util.StringHelper.nullIfEmpty;
2121

2222
/**
23-
* Standard implementation of DatabaseConnectionInfo
23+
* Standard implementation of {@link DatabaseConnectionInfo}
2424
*
2525
* @author Jan Schatteman
2626
*/

hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/spi/AbstractDataSourceBasedMultiTenantConnectionProviderImpl.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
import org.hibernate.service.UnknownUnwrapTypeException;
1212

1313
/**
14-
* Basic support for implementations of {@link MultiTenantConnectionProvider} based on DataSources.
14+
* Basic support for implementations of {@link MultiTenantConnectionProvider} based on {@link DataSource}s.
15+
*
1516
* @author Steve Ebersole
1617
*/
1718
public abstract class AbstractDataSourceBasedMultiTenantConnectionProviderImpl<T> implements MultiTenantConnectionProvider<T> {

0 commit comments

Comments
 (0)