fix: doc errors.

Author: arpan14

google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncResultSet.java

@@ -117,7 +117,7 @@ interface ReadyCallback {
    *       CursorState#NOT_READY}.
    * </ul>
    *
-   * <h2>Flow Control</h2>
+   * <h4>Flow Control</h4>
    *
    * If no flow control is needed (say because result sizes are known in advance to be finite in
    * size) then async processing is simple. The following is a code example that transfers work from

google-cloud-spanner/src/main/java/com/google/cloud/spanner/AsyncRunner.java

@@ -18,6 +18,7 @@
 
 import com.google.api.core.ApiFuture;
 import com.google.cloud.Timestamp;
+import io.grpc.Status.Code;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Executor;
 
@@ -40,8 +41,8 @@ interface AsyncWork<R> {
      * <p>In most cases, the implementation will not need to catch {@code SpannerException}s from
      * Spanner operations, instead letting these propagate to the framework. The transaction runner
      * will take appropriate action based on the type of exception. In particular, implementations
-     * should never catch an exception of type {@link SpannerErrors#isAborted}: these indicate that
-     * some reads may have returned inconsistent data and the transaction attempt must be aborted.
+     * should never catch an exception of type {@link Code#ABORTED}: these indicate that some reads
+     * may have returned inconsistent data and the transaction attempt must be aborted.
      *
      * @param txn the transaction
      * @return future over the result of the work

google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseAdminClient.java

@@ -137,7 +137,7 @@ default OperationFuture<Database, CreateDatabaseMetadata> createDatabase(
    * Database db = op.waitFor().getResult();
    * }</pre>
    *
-   * @see also #createDatabase(String, String, Iterable)
+   * @see #createDatabase(String, String, Iterable)
    */
   OperationFuture<Database, CreateDatabaseMetadata> createDatabase(
       Database database, Iterable<String> statements) throws SpannerException;

google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseClient.java

@@ -412,7 +412,7 @@ CommitResponse writeAtLeastOnceWithOptions(
    *
    * <p>Example of a read write transaction.
    *
-   * <pre> <code>
+   * <pre>{@code
    * Executor executor = Executors.newSingleThreadExecutor();
    * final long singerId = my_singer_id;
    * AsyncRunner runner = client.runAsync();
@@ -432,7 +432,7 @@ CommitResponse writeAtLeastOnceWithOptions(
    *                   .build());
    *         },
    *         executor);
-   * </code></pre>
+   * }</pre>
    *
    * Options for a transaction can include:
    *

google-cloud-spanner/src/main/java/com/google/cloud/spanner/InstanceConfigInfo.java

@@ -117,9 +117,9 @@ public List<ReplicaInfo> getOptionalReplicas() {
   }
 
   /**
-   * Base configuration, e.g. projects/<project_name>/instanceConfigs/nam3, based on which this
-   * configuration is created. Only set for user managed configurations. The base config must refer
-   * to a configuration of type GOOGLE_MANAGED.
+   * Base configuration, e.g. {@code projects/<project_name>/instanceConfigs/nam3}, based on which
+   * this configuration is created. Only set for user managed configurations. The base config must
+   * refer to a configuration of type GOOGLE_MANAGED.
    */
   public InstanceConfigInfo getBaseConfig() {
     return baseConfig;

google-cloud-spanner/src/main/java/com/google/cloud/spanner/Options.java

@@ -156,9 +156,9 @@ public static ListOption pageSize(int pageSize) {
   }
 
   /**
-   * If this is for a partitioned read & query and this field is set to `true`, the request will be
-   * executed via Spanner independent compute resources. The method is available in Beta mode (and
-   * is not generally available now).
+   * If this is for a partitioned read and query and this field is set to `true`, the request will
+   * be executed via Spanner independent compute resources. The method is available in Beta mode
+   * (and is not generally available now).
    */
   @BetaApi
   public static DataBoostQueryOption dataBoostEnabled(Boolean dataBoostEnabled) {

google-cloud-spanner/src/main/java/com/google/cloud/spanner/Session.java

@@ -18,6 +18,7 @@
 
 import com.google.api.core.ApiFuture;
 import com.google.api.core.InternalApi;
+import com.google.cloud.spanner.Options.TransactionOption;
 import com.google.protobuf.Empty;
 
 /**
@@ -48,11 +49,12 @@ public interface Session extends DatabaseClient, AutoCloseable {
   String getName();
 
   /**
-   * Prepares a transaction for use by a subsequent {@link #readWriteTransaction()} or {@link
-   * #write(Iterable)} call. It is not necessary to call this method before running a transaction or
-   * performing a write, but doing so may allow one round trip of the protocol to be performed in
-   * advance; calling this method on an idle session that is expected to execute a transaction or
-   * write in the near future may reduce the latency of the subsequent transaction/write.
+   * Prepares a transaction for use by a subsequent {@link
+   * DatabaseClient#readWriteTransaction(TransactionOption...)} or {@link #write(Iterable)} call. It
+   * is not necessary to call this method before running a transaction or performing a write, but
+   * doing so may allow one round trip of the protocol to be performed in advance; calling this
+   * method on an idle session that is expected to execute a transaction or write in the near future
+   * may reduce the latency of the subsequent transaction/write.
    */
   void prepareReadWriteTransaction();
 

google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionContext.java

@@ -17,6 +17,7 @@
 package com.google.cloud.spanner;
 
 import com.google.api.core.ApiFuture;
+import com.google.cloud.spanner.Options.TransactionOption;
 import com.google.cloud.spanner.Options.UpdateOption;
 import com.google.spanner.v1.ResultSetStats;
 
@@ -81,7 +82,7 @@
  * <p>If this behavior is undesirable, periodically executing a simple SQL query in the transaction
  * (e.g., {@code SELECT 1}) prevents the transaction from becoming idle.
  *
- * @see Session#readWriteTransaction()
+ * @see DatabaseClient#readWriteTransaction(TransactionOption...)
  * @see TransactionRunner
  */
 public interface TransactionContext extends ReadContext {

google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunner.java

@@ -17,13 +17,14 @@
 package com.google.cloud.spanner;
 
 import com.google.cloud.Timestamp;
+import com.google.cloud.spanner.Options.TransactionOption;
 import javax.annotation.Nullable;
 
 /**
  * An interface for executing a body of work in the context of a read-write transaction, with
  * retries for transaction aborts. See {@link TransactionContext} for a description of transaction
  * semantics. {@code TransactionRunner} instances are obtained by calling {@link
- * Session#readWriteTransaction()}.
+ * DatabaseClient#readWriteTransaction(TransactionOption...)}.
  *
  * <p>A {@code TransactionRunner} instance can only be used for a single invocation of {@link
  * #run(TransactionCallable)}.

google-cloud-spanner/src/test/java/com/google/cloud/spanner/GrpcResultSetTest.java

@@ -51,7 +51,7 @@
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
 
-/** Unit tests for {@link com.google.cloud.spanner.SpannerImpl.GrpcResultSet}. */
+/** Unit tests for {@link com.google.cloud.spanner.AbstractResultSet.GrpcResultSet}. */
 @RunWith(JUnit4.class)
 public class GrpcResultSetTest {
 

google-cloud-spanner/src/test/java/com/google/cloud/spanner/InstanceAdminClientImplTest.java

@@ -54,7 +54,7 @@
 import org.junit.runners.JUnit4;
 import org.mockito.Mock;
 
-/** Unit tests for {@link com.google.cloud.spanner.SpannerImpl.InstanceAdminClientImpl}. */
+/** Unit tests for {@link com.google.cloud.spanner.InstanceAdminClientImpl}. */
 @RunWith(JUnit4.class)
 public class InstanceAdminClientImplTest {
   private static final String PROJECT_ID = "my-project";

google-cloud-spanner/src/test/java/com/google/cloud/spanner/TransactionRunnerImplTest.java

@@ -73,7 +73,7 @@
 import org.mockito.Mockito;
 import org.mockito.MockitoAnnotations;
 
-/** Unit test for {@link com.google.cloud.spanner.SpannerImpl.TransactionRunnerImpl} */
+/** Unit test for {@link com.google.cloud.spanner.TransactionRunnerImpl} */
 @RunWith(JUnit4.class)
 public class TransactionRunnerImplTest {
   private static final class TestExecutorFactory

google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/AbstractSqlScriptVerifier.java

@@ -70,9 +70,9 @@
  *       equal. The value of a variable can be set using a @PUT statement.
  * </ul>
  *
- * The parser can set a temporary variable value using a @PUT statement: <code>
- * @PUT 'variable_name'\nSQL statement</code> The SQL statement must be a statement that returns a
- * {@link ResultSet} containing exactly one row and one column.
+ * The parser can set a temporary variable value using a @PUT statement: {@code @PUT
+ * 'variable_name'\nSQL statement} The SQL statement must be a statement that returns a {@link
+ * ResultSet} containing exactly one row and one column.
  *
  * <p>In addition the verifier can create new connections if the script contains NEW_CONNECTION;
  * statements and the verifier has been created with a {@link GenericConnectionProvider}. See {@link
@@ -130,7 +130,7 @@ protected abstract static class GenericStatementResult {
 
   /**
    * Generic wrapper around a connection to a database. The underlying connection could be a Spanner
-   * {@link com.google.cloud.spanner.jdbc.Connection} or a JDBC {@link java.sql.Connection}
+   * {@link com.google.cloud.spanner.connection.Connection} or a JDBC {@link java.sql.Connection}
    */
   public abstract static class GenericConnection implements AutoCloseable {
     protected abstract GenericStatementResult execute(String sql) throws Exception;
@@ -208,8 +208,8 @@ public AbstractSqlScriptVerifier(GenericConnectionProvider provider) {
    * Statements without an @EXPECT statement will be executed and its result will be ignored, unless
    * the statement throws an exception, which will fail the test case.
    *
-   * <p>The {@link com.google.cloud.spanner.jdbc.Connection}s that the statements are executed on
-   * must be created by a {@link GenericConnectionProvider}
+   * <p>The {@link com.google.cloud.spanner.connection.Connection}s that the statements are executed
+   * on must be created by a {@link GenericConnectionProvider}
    *
    * @param filename The file name containing the statements. Statements must be separated by a
    *     semicolon (;)
@@ -229,8 +229,8 @@ public void verifyStatementsInFile(String filename, Class<?> resourceClass, bool
    * Statements without an @EXPECT statement will be executed and its result will be ignored, unless
    * the statement throws an exception, which will fail the test case.
    *
-   * <p>The {@link com.google.cloud.spanner.jdbc.Connection}s that the statements are executed on
-   * must be created by a {@link GenericConnectionProvider}
+   * <p>The {@link com.google.cloud.spanner.connection.Connection}s that the statements are executed
+   * on must be created by a {@link GenericConnectionProvider}
    *
    * @param filename The file name containing the statements. Statements must be separated by a
    *     semicolon (;)
@@ -250,8 +250,8 @@ public void verifyStatementsInFile(String filename, Class<?> resourceClass) thro
    * Statements without an @EXPECT statement will be executed and its result will be ignored, unless
    * the statement throws an exception, which will fail the test case.
    *
-   * @param providedConnection The {@link com.google.cloud.spanner.jdbc.Connection} to execute the
-   *     statements against
+   * @param providedConnection The {@link com.google.cloud.spanner.connection.Connection} to execute
+   *     the statements against
    * @param filename The file name containing the statements. Statements must be separated by a
    *     semicolon (;)
    * @param resourceClass The class that defines the package where to find the input file
@@ -271,8 +271,8 @@ public void verifyStatementsInFile(
    * Statements without an @EXPECT statement will be executed and its result will be ignored, unless
    * the statement throws an exception, which will fail the test case.
    *
-   * @param providedConnection The {@link com.google.cloud.spanner.jdbc.Connection} to execute the
-   *     statements against
+   * @param providedConnection The {@link com.google.cloud.spanner.connection.Connection} to execute
+   *     the statements against
    * @param filename The file name containing the statements. Statements must be separated by a
    *     semicolon (;)
    * @param resourceClass The class that defines the package where to find the input file

google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SqlScriptVerifier.java

@@ -28,7 +28,8 @@
 import com.google.cloud.spanner.connection.StatementResult.ResultType;
 
 /**
- * SQL script verifier implementation for Spanner {@link com.google.cloud.spanner.jdbc.Connection}
+ * SQL script verifier implementation for Spanner {@link
+ * com.google.cloud.spanner.connection.Connection}
  *
  * @see AbstractSqlScriptVerifier for more information
  */