Skip to content

Commit c6326d9

Browse files
gcf-owl-bot[bot]sofisl
gcf-owl-bot[bot]
and
sofisl
authored
fix: [Many APIs] changing format of the jsdoc links (#3991)
* docs: changing format of the jsdoc links PiperOrigin-RevId: 509352615 Source-Link: googleapis/googleapis@b737d30 Source-Link: googleapis/googleapis-gen@8efadf3 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6IjhlZmFkZjNkNTg3ODBlYTFjNTUwMjY4ZDQ2YTNkYzcwMWJhMzdmY2YifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtbWFwc3BsYXRmb3JtZGF0YXNldHMvLk93bEJvdC55YW1sIiwiaCI6IjhlZmFkZjNkNTg3ODBlYTFjNTUwMjY4ZDQ2YTNkYzcwMWJhMzdmY2YifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtcm91dGluZy8uT3dsQm90LnlhbWwiLCJoIjoiOGVmYWRmM2Q1ODc4MGVhMWM1NTAyNjhkNDZhM2RjNzAxYmEzN2ZjZiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1vbml0b3JpbmctZGFzaGJvYXJkLy5Pd2xCb3QueWFtbCIsImgiOiI4ZWZhZGYzZDU4NzgwZWExYzU1MDI2OGQ0NmEzZGM3MDFiYTM3ZmNmIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLXByaXZhY3ktZGxwLy5Pd2xCb3QueWFtbCIsImgiOiI4ZWZhZGYzZDU4NzgwZWExYzU1MDI2OGQ0NmEzZGM3MDFiYTM3ZmNmIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLXN0b3JhZ2V0cmFuc2Zlci8uT3dsQm90LnlhbWwiLCJoIjoiOGVmYWRmM2Q1ODc4MGVhMWM1NTAyNjhkNDZhM2RjNzAxYmEzN2ZjZiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ3JhZmVhcy8uT3dsQm90LnlhbWwiLCJoIjoiOGVmYWRmM2Q1ODc4MGVhMWM1NTAyNjhkNDZhM2RjNzAxYmEzN2ZjZiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: sofisl <[email protected]>
1 parent fb2a6fd commit c6326d9

7 files changed

Lines changed: 120 additions & 122 deletions

File tree

‎packages/google-maps-addressvalidation/src/v1/address_validation_client.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ export class AddressValidationClient {
355355
* @param {object} [options]
356356
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
357357
* @returns {Promise} - The promise which resolves to an array.
358-
* The first element of the array is an object representing [ValidateAddressResponse]{@link google.maps.addressvalidation.v1.ValidateAddressResponse}.
358+
* The first element of the array is an object representing {@link google.maps.addressvalidation.v1.ValidateAddressResponse | ValidateAddressResponse}.
359359
* Please see the
360360
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
361361
* for more details and examples.
@@ -460,7 +460,7 @@ export class AddressValidationClient {
460460
* @param {object} [options]
461461
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
462462
* @returns {Promise} - The promise which resolves to an array.
463-
* The first element of the array is an object representing [ProvideValidationFeedbackResponse]{@link google.maps.addressvalidation.v1.ProvideValidationFeedbackResponse}.
463+
* The first element of the array is an object representing {@link google.maps.addressvalidation.v1.ProvideValidationFeedbackResponse | ProvideValidationFeedbackResponse}.
464464
* Please see the
465465
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
466466
* for more details and examples.

‎packages/google-maps-mapsplatformdatasets/src/v1alpha/maps_platform_datasets_v1_alpha_client.ts‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
354354
* @param {object} [options]
355355
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
356356
* @returns {Promise} - The promise which resolves to an array.
357-
* The first element of the array is an object representing [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset}.
357+
* The first element of the array is an object representing {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset}.
358358
* Please see the
359359
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
360360
* for more details and examples.
@@ -456,7 +456,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
456456
* @param {object} [options]
457457
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
458458
* @returns {Promise} - The promise which resolves to an array.
459-
* The first element of the array is an object representing [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset}.
459+
* The first element of the array is an object representing {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset}.
460460
* Please see the
461461
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
462462
* for more details and examples.
@@ -564,7 +564,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
564564
* @param {object} [options]
565565
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
566566
* @returns {Promise} - The promise which resolves to an array.
567-
* The first element of the array is an object representing [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset}.
567+
* The first element of the array is an object representing {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset}.
568568
* Please see the
569569
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
570570
* for more details and examples.
@@ -665,7 +665,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
665665
* @param {object} [options]
666666
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
667667
* @returns {Promise} - The promise which resolves to an array.
668-
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
668+
* The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
669669
* Please see the
670670
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
671671
* for more details and examples.
@@ -762,7 +762,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
762762
* @param {object} [options]
763763
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
764764
* @returns {Promise} - The promise which resolves to an array.
765-
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
765+
* The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
766766
* Please see the
767767
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
768768
* for more details and examples.
@@ -867,7 +867,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
867867
* @param {object} [options]
868868
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
869869
* @returns {Promise} - The promise which resolves to an array.
870-
* The first element of the array is Array of [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset}.
870+
* The first element of the array is Array of {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset}.
871871
* The client library will perform auto-pagination by default: it will call the API as many
872872
* times as needed and will merge results from all the pages into this array.
873873
* Note that it can affect your quota.
@@ -968,7 +968,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
968968
* @param {object} [options]
969969
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
970970
* @returns {Stream}
971-
* An object stream which emits an object representing [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset} on 'data' event.
971+
* An object stream which emits an object representing {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset} on 'data' event.
972972
* The client library will perform auto-pagination by default: it will call the API as many
973973
* times as needed. Note that it can affect your quota.
974974
* We recommend using `listDatasetVersionsAsync()`
@@ -1019,7 +1019,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
10191019
* @returns {Object}
10201020
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
10211021
* When you iterate the returned iterable, each element will be an object representing
1022-
* [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset}. The API will be called under the hood as needed, once per the page,
1022+
* {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset}. The API will be called under the hood as needed, once per the page,
10231023
* so you can stop the iteration when you don't need more results.
10241024
* Please see the
10251025
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
@@ -1065,7 +1065,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
10651065
* @param {object} [options]
10661066
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
10671067
* @returns {Promise} - The promise which resolves to an array.
1068-
* The first element of the array is Array of [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset}.
1068+
* The first element of the array is Array of {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset}.
10691069
* The client library will perform auto-pagination by default: it will call the API as many
10701070
* times as needed and will merge results from all the pages into this array.
10711071
* Note that it can affect your quota.
@@ -1166,7 +1166,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
11661166
* @param {object} [options]
11671167
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
11681168
* @returns {Stream}
1169-
* An object stream which emits an object representing [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset} on 'data' event.
1169+
* An object stream which emits an object representing {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset} on 'data' event.
11701170
* The client library will perform auto-pagination by default: it will call the API as many
11711171
* times as needed. Note that it can affect your quota.
11721172
* We recommend using `listDatasetsAsync()`
@@ -1217,7 +1217,7 @@ export class MapsPlatformDatasetsV1AlphaClient {
12171217
* @returns {Object}
12181218
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
12191219
* When you iterate the returned iterable, each element will be an object representing
1220-
* [Dataset]{@link google.maps.mapsplatformdatasets.v1alpha.Dataset}. The API will be called under the hood as needed, once per the page,
1220+
* {@link google.maps.mapsplatformdatasets.v1alpha.Dataset | Dataset}. The API will be called under the hood as needed, once per the page,
12211221
* so you can stop the iteration when you don't need more results.
12221222
* Please see the
12231223
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)

‎packages/google-maps-routing/src/v2/routes_client.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ export class RoutesClient {
420420
* @param {object} [options]
421421
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
422422
* @returns {Promise} - The promise which resolves to an array.
423-
* The first element of the array is an object representing [ComputeRoutesResponse]{@link google.maps.routing.v2.ComputeRoutesResponse}.
423+
* The first element of the array is an object representing {@link google.maps.routing.v2.ComputeRoutesResponse | ComputeRoutesResponse}.
424424
* Please see the
425425
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
426426
* for more details and examples.
@@ -565,7 +565,7 @@ export class RoutesClient {
565565
* @param {object} [options]
566566
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
567567
* @returns {Stream}
568-
* An object stream which emits [RouteMatrixElement]{@link google.maps.routing.v2.RouteMatrixElement} on 'data' event.
568+
* An object stream which emits {@link google.maps.routing.v2.RouteMatrixElement | RouteMatrixElement} on 'data' event.
569569
* Please see the
570570
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)
571571
* for more details and examples.

‎packages/google-monitoring-dashboard/src/v1/dashboards_service_client.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ export class DashboardsServiceClient {
369369
* @param {object} [options]
370370
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
371371
* @returns {Promise} - The promise which resolves to an array.
372-
* The first element of the array is an object representing [Dashboard]{@link google.monitoring.dashboard.v1.Dashboard}.
372+
* The first element of the array is an object representing {@link google.monitoring.dashboard.v1.Dashboard | Dashboard}.
373373
* Please see the
374374
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
375375
* for more details and examples.
@@ -468,7 +468,7 @@ export class DashboardsServiceClient {
468468
* @param {object} [options]
469469
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
470470
* @returns {Promise} - The promise which resolves to an array.
471-
* The first element of the array is an object representing [Dashboard]{@link google.monitoring.dashboard.v1.Dashboard}.
471+
* The first element of the array is an object representing {@link google.monitoring.dashboard.v1.Dashboard | Dashboard}.
472472
* Please see the
473473
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
474474
* for more details and examples.
@@ -565,7 +565,7 @@ export class DashboardsServiceClient {
565565
* @param {object} [options]
566566
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
567567
* @returns {Promise} - The promise which resolves to an array.
568-
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
568+
* The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
569569
* Please see the
570570
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
571571
* for more details and examples.
@@ -663,7 +663,7 @@ export class DashboardsServiceClient {
663663
* @param {object} [options]
664664
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
665665
* @returns {Promise} - The promise which resolves to an array.
666-
* The first element of the array is an object representing [Dashboard]{@link google.monitoring.dashboard.v1.Dashboard}.
666+
* The first element of the array is an object representing {@link google.monitoring.dashboard.v1.Dashboard | Dashboard}.
667667
* Please see the
668668
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
669669
* for more details and examples.
@@ -768,7 +768,7 @@ export class DashboardsServiceClient {
768768
* @param {object} [options]
769769
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
770770
* @returns {Promise} - The promise which resolves to an array.
771-
* The first element of the array is Array of [Dashboard]{@link google.monitoring.dashboard.v1.Dashboard}.
771+
* The first element of the array is Array of {@link google.monitoring.dashboard.v1.Dashboard | Dashboard}.
772772
* The client library will perform auto-pagination by default: it will call the API as many
773773
* times as needed and will merge results from all the pages into this array.
774774
* Note that it can affect your quota.
@@ -871,7 +871,7 @@ export class DashboardsServiceClient {
871871
* @param {object} [options]
872872
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
873873
* @returns {Stream}
874-
* An object stream which emits an object representing [Dashboard]{@link google.monitoring.dashboard.v1.Dashboard} on 'data' event.
874+
* An object stream which emits an object representing {@link google.monitoring.dashboard.v1.Dashboard | Dashboard} on 'data' event.
875875
* The client library will perform auto-pagination by default: it will call the API as many
876876
* times as needed. Note that it can affect your quota.
877877
* We recommend using `listDashboardsAsync()`
@@ -924,7 +924,7 @@ export class DashboardsServiceClient {
924924
* @returns {Object}
925925
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
926926
* When you iterate the returned iterable, each element will be an object representing
927-
* [Dashboard]{@link google.monitoring.dashboard.v1.Dashboard}. The API will be called under the hood as needed, once per the page,
927+
* {@link google.monitoring.dashboard.v1.Dashboard | Dashboard}. The API will be called under the hood as needed, once per the page,
928928
* so you can stop the iteration when you don't need more results.
929929
* Please see the
930930
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)

0 commit comments

Comments
 (0)