Skip to content

Commit 552f491

Browse files
authored
docs: fix BigQuery documentation formating (#3565)
* fix parentheses and use @see to link direct link * more doc fix
1 parent 20705d1 commit 552f491

File tree

1 file changed

+10
-13
lines changed
  • google-cloud-bigquery/src/main/java/com/google/cloud/bigquery

1 file changed

+10
-13
lines changed

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,9 @@ private DatasetListOption(BigQueryRpc.Option option, Object value) {
244244
}
245245

246246
/**
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>
249250
*
250251
* @param labelFilter In the form "labels.key:value"
251252
*/
@@ -280,7 +281,7 @@ private DatasetOption(BigQueryRpc.Option option, Object value) {
280281

281282
/**
282283
* 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
284285
* used to specify only the fields of interest. {@link Dataset#getDatasetId()} is always
285286
* returned, even if not specified.
286287
*/
@@ -864,8 +865,7 @@ public int hashCode() {
864865
/**
865866
* Lists the project's datasets. This method returns partial information on each dataset: ({@link
866867
* 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}.
869869
*
870870
* <p>Example of listing datasets, specifying the page size.
871871
*
@@ -884,8 +884,7 @@ public int hashCode() {
884884
/**
885885
* Lists the datasets in the provided project. This method returns partial information on each
886886
* 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}.
889888
*
890889
* <p>Example of listing datasets in a project, specifying the page size.
891890
*
@@ -1205,7 +1204,7 @@ public int hashCode() {
12051204
* Lists the tables in the dataset. This method returns partial information on each table: ({@link
12061205
* Table#getTableId()}, {@link Table#getFriendlyName()}, {@link Table#getGeneratedId()} and type,
12071206
* 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}.
12091208
*
12101209
* <p>Example of listing the tables in a dataset, specifying the page size.
12111210
*
@@ -1225,7 +1224,7 @@ public int hashCode() {
12251224
* Lists the tables in the dataset. This method returns partial information on each table: ({@link
12261225
* Table#getTableId()}, {@link Table#getFriendlyName()}, {@link Table#getGeneratedId()} and type,
12271226
* 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}.
12291228
*
12301229
* <p>Example of listing the tables in a dataset.
12311230
*
@@ -1429,8 +1428,7 @@ TableResult listTableData(
14291428

14301429
/**
14311430
* 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}.
14341432
*
14351433
* <p>If the location of the job is not "US" or "EU", {@link #cancel(JobId)} must be used instead.
14361434
*
@@ -1454,8 +1452,7 @@ TableResult listTableData(
14541452

14551453
/**
14561454
* 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}.
14591456
*
14601457
* <p>If the location of the job is not "US" or "EU", the {@code jobId} must specify the job
14611458
* location.

0 commit comments

Comments
 (0)