fix doc (#1966)

googleapis · Oct 15, 2018 · 4d9d113 · 4d9d113
1 parent c69f80d
commit 4d9d113
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 13 deletions.
diff --git a/...igtable-client-core/src/main/java/com/google/cloud/bigtable/core/IBigtableDataClient.java b/...igtable-client-core/src/main/java/com/google/cloud/bigtable/core/IBigtableDataClient.java
@@ -32,17 +32,18 @@ public interface IBigtableDataClient {
    * Mutate a row atomically.
    *
    * @param rowMutation a {@link RowMutation} model object.
-   * @throws ExecutionException
-   * @throws InterruptedException
+   * @throws ExecutionException if any.
+   * @throws InterruptedException if any.
    */
   void mutateRow(RowMutation rowMutation) throws ExecutionException, InterruptedException;
 
   /**
    * Mutate a row atomically.
    *
    * @param rowMutation a {@link RowMutation} model object.
-   * @return ApiFuture</Void> returns api future.
-   * @throws InterruptedException
+   * @return a {@link ApiFuture} of type {@link Void} will be set when request is
+   *     successful otherwise exception will be thrown.
+   * @throws InterruptedException if any.
    */
   ApiFuture<Void> mutateRowAsync(RowMutation rowMutation) throws InterruptedException;
 
@@ -51,8 +52,8 @@ public interface IBigtableDataClient {
    *
    * @param readModifyWriteRow a {@link ReadModifyWriteRow} model object.
    * @return Row a modified row.
-   * @throws ExecutionException
-   * @throws InterruptedException
+   * @throws ExecutionException if any.
+   * @throws InterruptedException if any.
    */
   Row readModifyWriteRow(ReadModifyWriteRow readModifyWriteRow)
       throws ExecutionException, InterruptedException;
@@ -61,8 +62,9 @@ Row readModifyWriteRow(ReadModifyWriteRow readModifyWriteRow)
    * Perform an atomic read-modify-write operation on a row.
    *
    * @param readModifyWriteRow a {@link ReadModifyWriteRow} model object.
-   * @return ApiFuture<Row> returns future.
-   * @throws InterruptedException
+   * @return a {@link ApiFuture} of type {@link Row} will be set when request is
+   *     successful otherwise exception will be thrown.
+   * @throws InterruptedException if any.
    */
   ApiFuture<Row> readModifyWriteRowAsync(ReadModifyWriteRow readModifyWriteRow) throws InterruptedException;
 
@@ -75,7 +77,8 @@ Row readModifyWriteRow(ReadModifyWriteRow readModifyWriteRow)
    * Mutate a row atomically dependent on a precondition.
    *
    * @param conditionalRowMutation a {@link ConditionalRowMutation} model object.
-   * @return ApiFuture<Boolean> returns api future.
+   * @return a {@link ApiFuture} of type {@link Boolean} will be set when request is
+   *     successful otherwise exception will be thrown.
    */
   ApiFuture<Boolean> checkAndMutateRowAsync(ConditionalRowMutation conditionalRowMutation);
 
@@ -84,8 +87,8 @@ Row readModifyWriteRow(ReadModifyWriteRow readModifyWriteRow)
    *
    * @param conditionalRowMutation a {@link ConditionalRowMutation} model object.
    * @return Boolean returns true if predicate returns any result.
-   * @throws ExecutionException
-   * @throws InterruptedException
+   * @throws ExecutionException if any.
+   * @throws InterruptedException if any.
    */
   Boolean checkAndMutateRow(ConditionalRowMutation conditionalRowMutation)
       throws ExecutionException, InterruptedException;

diff --git a/...rent/bigtable-client-core/src/main/java/com/google/cloud/bigtable/core/IBulkMutation.java b/...rent/bigtable-client-core/src/main/java/com/google/cloud/bigtable/core/IBulkMutation.java
@@ -45,8 +45,8 @@ public interface IBulkMutation {
    * mechanism.
    *
    * @param rowMutation The {@link com.google.cloud.bigtable.data.v2.models.RowMutation} to add
-   * @return a {@link com.google.common.util.concurrent.SettableFuture} will be set when request is
-   * successful otherwise exception will be thrown.
+   * @return a {@link ApiFuture} of type {@link Void} will be set when request is
+   *     successful otherwise exception will be thrown.
    */
   ApiFuture<Void> add(RowMutation rowMutation);
 }