Skip to content

Commit ccbba86

Browse files
authored
chore(cloud-rad): fix links for TSDocs (#742)
sed -i -e 's/\[\(.*\)\](\(.*\))/{@link \2| \1}/' src/**/*.ts
1 parent cf448d1 commit ccbba86

File tree

3 files changed

+40
-40
lines changed

3 files changed

+40
-40
lines changed

packages/google-cloud-translate/src/v2/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ export interface TranslateConfig extends GoogleAuthOptions {
103103
* native Promises.
104104
*/
105105
/**
106-
* With [Google Translate](https://cloud.google.com/translate), you can
106+
* With {@link https://cloud.google.com/translate| Google Translate}, you can
107107
* dynamically translate text between thousands of language pairs.
108108
*
109109
* The Google Cloud Translation API lets websites and programs integrate with
@@ -293,7 +293,7 @@ export class Translate extends Service {
293293
/**
294294
* @typedef {object} LanguageResult
295295
* @memberof v2
296-
* @property {string} code The [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)
296+
* @property {string} code The {@link https://en.wikipedia.org/wiki/ISO_639-1| ISO 639-1}
297297
* language code.
298298
* @property {string} name The language name. This can be translated into your
299299
* preferred language with the `target` option.
@@ -303,7 +303,7 @@ export class Translate extends Service {
303303
* @memberof v2
304304
* @param {?Error} err Request error, if any.
305305
* @param {object[]} results The languages supported by the API.
306-
* @param {string} results.code The [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)
306+
* @param {string} results.code The {@link https://en.wikipedia.org/wiki/ISO_639-1| ISO 639-1}
307307
* language code.
308308
* @param {string} results.name The language name. This can be translated into your
309309
* preferred language with the `target` option.
@@ -425,7 +425,7 @@ export class Translate extends Service {
425425
/**
426426
* Translate a string or multiple strings into another language.
427427
*
428-
* @see [Translate Text](https://cloud.google.com/translate/v2/using_rest#Translate)
428+
* @see {@link https://cloud.google.com/translate/v2/using_rest#Translate| Translate Text}
429429
*
430430
* @throws {Error} If `options` is provided as an object without a `to`
431431
* property.

packages/google-cloud-translate/src/v3/translation_service_client.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export class TranslationServiceClient {
7272
*
7373
* @param {object} [options] - The configuration object.
7474
* The options accepted by the constructor are described in detail
75-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
75+
* in {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance| this document}.
7676
* The common options are:
7777
* @param {object} [options.credentials] - Credentials object.
7878
* @param {string} [options.credentials.client_email]
@@ -501,7 +501,7 @@ export class TranslationServiceClient {
501501
* @returns {Promise} - The promise which resolves to an array.
502502
* The first element of the array is an object representing [TranslateTextResponse]{@link google.cloud.translation.v3.TranslateTextResponse}.
503503
* Please see the
504-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
504+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
505505
* for more details and examples.
506506
* @example
507507
* const [response] = await client.translateText(request);
@@ -627,7 +627,7 @@ export class TranslationServiceClient {
627627
* @returns {Promise} - The promise which resolves to an array.
628628
* The first element of the array is an object representing [DetectLanguageResponse]{@link google.cloud.translation.v3.DetectLanguageResponse}.
629629
* Please see the
630-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
630+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
631631
* for more details and examples.
632632
* @example
633633
* const [response] = await client.detectLanguage(request);
@@ -751,7 +751,7 @@ export class TranslationServiceClient {
751751
* @returns {Promise} - The promise which resolves to an array.
752752
* The first element of the array is an object representing [SupportedLanguages]{@link google.cloud.translation.v3.SupportedLanguages}.
753753
* Please see the
754-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
754+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
755755
* for more details and examples.
756756
* @example
757757
* const [response] = await client.getSupportedLanguages(request);
@@ -902,7 +902,7 @@ export class TranslationServiceClient {
902902
* @returns {Promise} - The promise which resolves to an array.
903903
* The first element of the array is an object representing [TranslateDocumentResponse]{@link google.cloud.translation.v3.TranslateDocumentResponse}.
904904
* Please see the
905-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
905+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
906906
* for more details and examples.
907907
* @example
908908
* const [response] = await client.translateDocument(request);
@@ -990,7 +990,7 @@ export class TranslationServiceClient {
990990
* @returns {Promise} - The promise which resolves to an array.
991991
* The first element of the array is an object representing [Glossary]{@link google.cloud.translation.v3.Glossary}.
992992
* Please see the
993-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
993+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
994994
* for more details and examples.
995995
* @example
996996
* const [response] = await client.getGlossary(request);
@@ -1143,7 +1143,7 @@ export class TranslationServiceClient {
11431143
* a long running operation. Its `promise()` method returns a promise
11441144
* you can `await` for.
11451145
* Please see the
1146-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1146+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
11471147
* for more details and examples.
11481148
* @example
11491149
* const [operation] = await client.batchTranslateText(request);
@@ -1204,7 +1204,7 @@ export class TranslationServiceClient {
12041204
* @returns {Promise} - The promise which resolves to an object.
12051205
* The decoded operation object has result and metadata field to get information from.
12061206
* Please see the
1207-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1207+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
12081208
* for more details and examples.
12091209
* @example
12101210
* const decodedOperation = await checkBatchTranslateTextProgress(name);
@@ -1343,7 +1343,7 @@ export class TranslationServiceClient {
13431343
* a long running operation. Its `promise()` method returns a promise
13441344
* you can `await` for.
13451345
* Please see the
1346-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1346+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
13471347
* for more details and examples.
13481348
* @example
13491349
* const [operation] = await client.batchTranslateDocument(request);
@@ -1408,7 +1408,7 @@ export class TranslationServiceClient {
14081408
* @returns {Promise} - The promise which resolves to an object.
14091409
* The decoded operation object has result and metadata field to get information from.
14101410
* Please see the
1411-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1411+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
14121412
* for more details and examples.
14131413
* @example
14141414
* const decodedOperation = await checkBatchTranslateDocumentProgress(name);
@@ -1491,7 +1491,7 @@ export class TranslationServiceClient {
14911491
* a long running operation. Its `promise()` method returns a promise
14921492
* you can `await` for.
14931493
* Please see the
1494-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1494+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
14951495
* for more details and examples.
14961496
* @example
14971497
* const [operation] = await client.createGlossary(request);
@@ -1552,7 +1552,7 @@ export class TranslationServiceClient {
15521552
* @returns {Promise} - The promise which resolves to an object.
15531553
* The decoded operation object has result and metadata field to get information from.
15541554
* Please see the
1555-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1555+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
15561556
* for more details and examples.
15571557
* @example
15581558
* const decodedOperation = await checkCreateGlossaryProgress(name);
@@ -1634,7 +1634,7 @@ export class TranslationServiceClient {
16341634
* a long running operation. Its `promise()` method returns a promise
16351635
* you can `await` for.
16361636
* Please see the
1637-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1637+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
16381638
* for more details and examples.
16391639
* @example
16401640
* const [operation] = await client.deleteGlossary(request);
@@ -1695,7 +1695,7 @@ export class TranslationServiceClient {
16951695
* @returns {Promise} - The promise which resolves to an object.
16961696
* The decoded operation object has result and metadata field to get information from.
16971697
* Please see the
1698-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
1698+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
16991699
* for more details and examples.
17001700
* @example
17011701
* const decodedOperation = await checkDeleteGlossaryProgress(name);
@@ -1799,7 +1799,7 @@ export class TranslationServiceClient {
17991799
* We recommend using `listGlossariesAsync()`
18001800
* method described below for async iteration which you can stop as needed.
18011801
* Please see the
1802-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1802+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination| documentation}
18031803
* for more details and examples.
18041804
*/
18051805
listGlossaries(
@@ -1886,7 +1886,7 @@ export class TranslationServiceClient {
18861886
* We recommend using `listGlossariesAsync()`
18871887
* method described below for async iteration which you can stop as needed.
18881888
* Please see the
1889-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1889+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination| documentation}
18901890
* for more details and examples.
18911891
*/
18921892
listGlossariesStream(
@@ -1947,12 +1947,12 @@ export class TranslationServiceClient {
19471947
* @param {object} [options]
19481948
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
19491949
* @returns {Object}
1950-
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
1950+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols| async iteration}.
19511951
* When you iterate the returned iterable, each element will be an object representing
19521952
* [Glossary]{@link google.cloud.translation.v3.Glossary}. The API will be called under the hood as needed, once per the page,
19531953
* so you can stop the iteration when you don't need more results.
19541954
* Please see the
1955-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
1955+
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination| documentation}
19561956
* for more details and examples.
19571957
* @example
19581958
* const iterable = client.listGlossariesAsync(request);

0 commit comments

Comments
 (0)