Skip to content

Commit 2ac1964

Browse files
authored
docs: fix javadoc formatting (#343)
* docs: fix javadoc formatting One of the descriptions of the supported connection properties missed an ending </code> block, which caused the entire formatting to be incorrect. Fixes #342 * fix: 'will be' => 'is'
1 parent 6ea0a26 commit 2ac1964

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@
6767
* The property-value strings should be url-encoded.
6868
*
6969
* <p>The project-id part of the URI may be filled with the placeholder DEFAULT_PROJECT_ID. This
70-
* placeholder will be replaced by the default project id of the environment that is requesting a
70+
* placeholder is replaced by the default project id of the environment that is requesting a
7171
* connection.
7272
*
7373
* <p>The supported properties are:
7474
*
7575
* <ul>
7676
* <li>credentials (String): URL for the credentials file to use for the connection. If you do not
7777
* specify any credentials at all, the default credentials of the environment as returned by
78-
* {@link GoogleCredentials#getApplicationDefault()} will be used.
78+
* {@link GoogleCredentials#getApplicationDefault()} is used.
7979
* <li>oauthtoken (String): A valid OAuth2 token to use for the JDBC connection. The token must
8080
* have been obtained with one or both of the scopes
8181
* 'https://www.googleapis.com/auth/spanner.admin' and/or
@@ -89,8 +89,15 @@
8989
* com.google.cloud.spanner.jdbc.CloudSpannerJdbcConnection#setRetryAbortsInternally(boolean)}
9090
* for more information.
9191
* <li>numChannels (int): Sets the number of gRPC channels to use. Defaults to 4.
92-
* <li>usePlainText (boolean): Sets whether the JDBC connection should establish an unencrypted connection to the server. This option can only be used when connecting to a local emulator that does not require an encrypted connection, and that does not require authentication.
93-
* <li>optimizerVersion (string): The query optimizer version to use for the connection. The value must be either a valid version number or <code>LATEST</code>. If no value is specified, the query optimizer version specified in the environment variable <code>SPANNER_OPTIMIZER_VERSION<code> will be used. If no query optimizer version is specified in the connection URL or in the environment variable, the default query optimizer version of Cloud Spanner will be used.
92+
* <li>usePlainText (boolean): Sets whether the JDBC connection should establish an unencrypted
93+
* connection to the server. This option can only be used when connecting to a local emulator
94+
* that does not require an encrypted connection, and that does not require authentication.
95+
* <li>optimizerVersion (string): The query optimizer version to use for the connection. The value
96+
* must be either a valid version number or <code>LATEST</code>. If no value is specified, the
97+
* query optimizer version specified in the environment variable <code>
98+
* SPANNER_OPTIMIZER_VERSION</code> is used. If no query optimizer version is specified in the
99+
* connection URL or in the environment variable, the default query optimizer version of Cloud
100+
* Spanner is used.
94101
* </ul>
95102
*/
96103
public class JdbcDriver implements Driver {

0 commit comments

Comments
 (0)