docs: fix BigQuery documentation formating (#3565)

PhongChuong · web-flow · commit 552f49132af3 · 2024-11-04T10:45:14.000-05:00
* fix parentheses and use @see to link direct link * more doc fix
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java
@@ -244,8 +244,9 @@ private DatasetListOption(BigQueryRpc.Option option, Object value) {
     }
 
     /**
-     * Returns an option to specify a label filter. See
-     * https://cloud.google.com/bigquery/docs/adding-using-labels#filtering_datasets_using_labels
+     * Returns an option to specify a label filter. @see <a href=
+     * "https://cloud.google.com/bigquery/docs/adding-using-labels#filtering_datasets_using_labels">Filtering
+     * using labels</a>
      *
      * @param labelFilter In the form "labels.key:value"
      */
@@ -280,7 +281,7 @@ private DatasetOption(BigQueryRpc.Option option, Object value) {
 
     /**
      * Returns an option to specify the dataset's fields to be returned by the RPC call. If this
-     * option is not provided all dataset's fields are returned. { code DatasetOption.fields} can be
+     * option is not provided all dataset's fields are returned. {@code DatasetOption.fields} can be
      * used to specify only the fields of interest. {@link Dataset#getDatasetId()} is always
      * returned, even if not specified.
      */
@@ -864,8 +865,7 @@ public int hashCode() {
   /**
    * Lists the project's datasets. This method returns partial information on each dataset: ({@link
    * Dataset#getDatasetId()}, {@link Dataset#getFriendlyName()} and {@link
-   * Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset(String,
-   * DatasetOption...)} or {@link #getDataset(DatasetId, DatasetOption...)}.
+   * Dataset#getGeneratedId()}). To get complete information use {@link #getDataset}.
    *
    * <p>Example of listing datasets, specifying the page size.
    *
@@ -884,8 +884,7 @@ public int hashCode() {
   /**
    * Lists the datasets in the provided project. This method returns partial information on each
    * dataset: ({@link Dataset#getDatasetId()}, {@link Dataset#getFriendlyName()} and {@link
-   * Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset(String,
-   * DatasetOption...)} or {@link #getDataset(DatasetId, DatasetOption...)}.
+   * Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset}.
    *
    * <p>Example of listing datasets in a project, specifying the page size.
    *
@@ -1205,7 +1204,7 @@ public int hashCode() {
    * Lists the tables in the dataset. This method returns partial information on each table: ({@link
    * Table#getTableId()}, {@link Table#getFriendlyName()}, {@link Table#getGeneratedId()} and type,
    * which is part of {@link Table#getDefinition()}). To get complete information use either {@link
-   * #getTable(TableId, TableOption...)} or {@link #getTable(String, String, TableOption...)}.
+   * #getTable}.
    *
    * <p>Example of listing the tables in a dataset, specifying the page size.
    *
@@ -1225,7 +1224,7 @@ public int hashCode() {
    * Lists the tables in the dataset. This method returns partial information on each table: ({@link
    * Table#getTableId()}, {@link Table#getFriendlyName()}, {@link Table#getGeneratedId()} and type,
    * which is part of {@link Table#getDefinition()}). To get complete information use either {@link
-   * #getTable(TableId, TableOption...)} or {@link #getTable(String, String, TableOption...)}.
+   * #getTable}.
    *
    * <p>Example of listing the tables in a dataset.
    *
@@ -1429,8 +1428,7 @@ TableResult listTableData(
 
   /**
    * Sends a job cancel request. This call will return immediately. The job status can then be
-   * checked using either {@link #getJob(JobId, JobOption...)} or {@link #getJob(String,
-   * JobOption...)}).
+   * checked by using {@link #getJob}.
    *
    * <p>If the location of the job is not "US" or "EU", {@link #cancel(JobId)} must be used instead.
    *
@@ -1454,8 +1452,7 @@ TableResult listTableData(
 
   /**
    * Sends a job cancel request. This call will return immediately. The job status can then be
-   * checked using either {@link #getJob(JobId, JobOption...)} or {@link #getJob(String,
-   * JobOption...)}).
+   * checked using {@link #getJob}.
    *
    * <p>If the location of the job is not "US" or "EU", the {@code jobId} must specify the job
    * location.

Original file line number	Diff line number	Diff line change
`@@ -244,8 +244,9 @@ private DatasetListOption(BigQueryRpc.Option option, Object value) {`
`244`	`244`	`}`
`245`	`245`
`246`	`246`	`/**`
`247`		`- * Returns an option to specify a label filter. See`
`248`		`- * https://cloud.google.com/bigquery/docs/adding-using-labels#filtering_datasets_using_labels`
	`247`	`+ * Returns an option to specify a label filter. @see <a href=`
	`248`	`+ * "https://cloud.google.com/bigquery/docs/adding-using-labels#filtering_datasets_using_labels">Filtering`
	`249`	`+ * using labels</a>`
`249`	`250`	`*`
`250`	`251`	`* @param labelFilter In the form "labels.key:value"`
`251`	`252`	`*/`
`@@ -280,7 +281,7 @@ private DatasetOption(BigQueryRpc.Option option, Object value) {`
`280`	`281`
`281`	`282`	`/**`
`282`	`283`	`* Returns an option to specify the dataset's fields to be returned by the RPC call. If this`
`283`		`- * option is not provided all dataset's fields are returned. { code DatasetOption.fields} can be`
	`284`	`+ * option is not provided all dataset's fields are returned. {@code DatasetOption.fields} can be`
`284`	`285`	`* used to specify only the fields of interest. {@link Dataset#getDatasetId()} is always`
`285`	`286`	`* returned, even if not specified.`
`286`	`287`	`*/`
`@@ -864,8 +865,7 @@ public int hashCode() {`
`864`	`865`	`/**`
`865`	`866`	`* Lists the project's datasets. This method returns partial information on each dataset: ({@link`
`866`	`867`	`* Dataset#getDatasetId()}, {@link Dataset#getFriendlyName()} and {@link`
`867`		`- * Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset(String,`
`868`		`- * DatasetOption...)} or {@link #getDataset(DatasetId, DatasetOption...)}.`
	`868`	`+ * Dataset#getGeneratedId()}). To get complete information use {@link #getDataset}.`
`869`	`869`	`*`
`870`	`870`	`* <p>Example of listing datasets, specifying the page size.`
`871`	`871`	`*`
`@@ -884,8 +884,7 @@ public int hashCode() {`
`884`	`884`	`/**`
`885`	`885`	`* Lists the datasets in the provided project. This method returns partial information on each`
`886`	`886`	`* dataset: ({@link Dataset#getDatasetId()}, {@link Dataset#getFriendlyName()} and {@link`
`887`		`- * Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset(String,`
`888`		`- * DatasetOption...)} or {@link #getDataset(DatasetId, DatasetOption...)}.`
	`887`	`+ * Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset}.`
`889`	`888`	`*`
`890`	`889`	`* <p>Example of listing datasets in a project, specifying the page size.`
`891`	`890`	`*`
`@@ -1205,7 +1204,7 @@ public int hashCode() {`
`1205`	`1204`	`* Lists the tables in the dataset. This method returns partial information on each table: ({@link`
`1206`	`1205`	`* Table#getTableId()}, {@link Table#getFriendlyName()}, {@link Table#getGeneratedId()} and type,`
`1207`	`1206`	`* which is part of {@link Table#getDefinition()}). To get complete information use either {@link`
`1208`		`- * #getTable(TableId, TableOption...)} or {@link #getTable(String, String, TableOption...)}.`
	`1207`	`+ * #getTable}.`
`1209`	`1208`	`*`
`1210`	`1209`	`* <p>Example of listing the tables in a dataset, specifying the page size.`
`1211`	`1210`	`*`
`@@ -1225,7 +1224,7 @@ public int hashCode() {`
`1225`	`1224`	`* Lists the tables in the dataset. This method returns partial information on each table: ({@link`
`1226`	`1225`	`* Table#getTableId()}, {@link Table#getFriendlyName()}, {@link Table#getGeneratedId()} and type,`
`1227`	`1226`	`* which is part of {@link Table#getDefinition()}). To get complete information use either {@link`
`1228`		`- * #getTable(TableId, TableOption...)} or {@link #getTable(String, String, TableOption...)}.`
	`1227`	`+ * #getTable}.`
`1229`	`1228`	`*`
`1230`	`1229`	`* <p>Example of listing the tables in a dataset.`
`1231`	`1230`	`*`
`@@ -1429,8 +1428,7 @@ TableResult listTableData(`
`1429`	`1428`
`1430`	`1429`	`/**`
`1431`	`1430`	`* Sends a job cancel request. This call will return immediately. The job status can then be`
`1432`		`- * checked using either {@link #getJob(JobId, JobOption...)} or {@link #getJob(String,`
`1433`		`- * JobOption...)}).`
	`1431`	`+ * checked by using {@link #getJob}.`
`1434`	`1432`	`*`
`1435`	`1433`	`* <p>If the location of the job is not "US" or "EU", {@link #cancel(JobId)} must be used instead.`
`1436`	`1434`	`*`
`@@ -1454,8 +1452,7 @@ TableResult listTableData(`
`1454`	`1452`
`1455`	`1453`	`/**`
`1456`	`1454`	`* Sends a job cancel request. This call will return immediately. The job status can then be`
`1457`		`- * checked using either {@link #getJob(JobId, JobOption...)} or {@link #getJob(String,`
`1458`		`- * JobOption...)}).`
	`1455`	`+ * checked using {@link #getJob}.`
`1459`	`1456`	`*`
`1460`	`1457`	`* <p>If the location of the job is not "US" or "EU", the {@code jobId} must specify the job`
`1461`	`1458`	`* location.`