Skip to content

Commit

Permalink
chore(cloud-rad): fix links for TSDocs (#742)
Browse files Browse the repository at this point in the history 
sed -i -e 's/\[\(.*\)\](\(.*\))/{@link \2| \1}/' src/**/*.ts
  • Loading branch information
@fhinkel
fhinkel authored Nov 3, 2021
1 parent cf448d1 commit ccbba86
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 40 deletions.
8 changes: 4 additions & 4 deletions packages/google-cloud-translate/src/v2/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export interface TranslateConfig extends GoogleAuthOptions {
* native Promises.
*/
/**
* With [Google Translate](https://cloud.google.com/translate), you can
* With {@link https://cloud.google.com/translate| Google Translate}, you can
* dynamically translate text between thousands of language pairs.
*
* The Google Cloud Translation API lets websites and programs integrate with
Expand Down Expand Up @@ -293,7 +293,7 @@ export class Translate extends Service {
/**
* @typedef {object} LanguageResult
* @memberof v2
* @property {string} code The [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)
* @property {string} code The {@link https://en.wikipedia.org/wiki/ISO_639-1| ISO 639-1}
* language code.
* @property {string} name The language name. This can be translated into your
* preferred language with the `target` option.
Expand All @@ -303,7 +303,7 @@ export class Translate extends Service {
* @memberof v2
* @param {?Error} err Request error, if any.
* @param {object[]} results The languages supported by the API.
* @param {string} results.code The [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)
* @param {string} results.code The {@link https://en.wikipedia.org/wiki/ISO_639-1| ISO 639-1}
* language code.
* @param {string} results.name The language name. This can be translated into your
* preferred language with the `target` option.
Expand Down Expand Up @@ -425,7 +425,7 @@ export class Translate extends Service {
/**
* Translate a string or multiple strings into another language.
*
* @see [Translate Text](https://cloud.google.com/translate/v2/using_rest#Translate)
* @see {@link https://cloud.google.com/translate/v2/using_rest#Translate| Translate Text}
*
* @throws {Error} If `options` is provided as an object without a `to`
* property.
Expand Down
36 changes: 18 additions & 18 deletions packages/google-cloud-translate/src/v3/translation_service_client.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export class TranslationServiceClient {
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
* in {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance| this document}.
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
Expand Down Expand Up @@ -501,7 +501,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [TranslateTextResponse]{@link google.cloud.translation.v3.TranslateTextResponse}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
* for more details and examples.
* @example
* const [response] = await client.translateText(request);
Expand Down Expand Up @@ -627,7 +627,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [DetectLanguageResponse]{@link google.cloud.translation.v3.DetectLanguageResponse}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
* for more details and examples.
* @example
* const [response] = await client.detectLanguage(request);
Expand Down Expand Up @@ -751,7 +751,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [SupportedLanguages]{@link google.cloud.translation.v3.SupportedLanguages}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
* for more details and examples.
* @example
* const [response] = await client.getSupportedLanguages(request);
Expand Down Expand Up @@ -902,7 +902,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [TranslateDocumentResponse]{@link google.cloud.translation.v3.TranslateDocumentResponse}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
* for more details and examples.
* @example
* const [response] = await client.translateDocument(request);
Expand Down Expand Up @@ -990,7 +990,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing [Glossary]{@link google.cloud.translation.v3.Glossary}.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods| documentation}
* for more details and examples.
* @example
* const [response] = await client.getGlossary(request);
Expand Down Expand Up @@ -1143,7 +1143,7 @@ export class TranslationServiceClient {
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
* for more details and examples.
* @example
* const [operation] = await client.batchTranslateText(request);
Expand Down Expand Up @@ -1204,7 +1204,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
* for more details and examples.
* @example
* const decodedOperation = await checkBatchTranslateTextProgress(name);
Expand Down Expand Up @@ -1343,7 +1343,7 @@ export class TranslationServiceClient {
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
* for more details and examples.
* @example
* const [operation] = await client.batchTranslateDocument(request);
Expand Down Expand Up @@ -1408,7 +1408,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
* for more details and examples.
* @example
* const decodedOperation = await checkBatchTranslateDocumentProgress(name);
Expand Down Expand Up @@ -1491,7 +1491,7 @@ export class TranslationServiceClient {
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
* for more details and examples.
* @example
* const [operation] = await client.createGlossary(request);
Expand Down Expand Up @@ -1552,7 +1552,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
* for more details and examples.
* @example
* const decodedOperation = await checkCreateGlossaryProgress(name);
Expand Down Expand Up @@ -1634,7 +1634,7 @@ export class TranslationServiceClient {
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
* for more details and examples.
* @example
* const [operation] = await client.deleteGlossary(request);
Expand Down Expand Up @@ -1695,7 +1695,7 @@ export class TranslationServiceClient {
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations| documentation}
* for more details and examples.
* @example
* const decodedOperation = await checkDeleteGlossaryProgress(name);
Expand Down Expand Up @@ -1799,7 +1799,7 @@ export class TranslationServiceClient {
* We recommend using `listGlossariesAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination| documentation}
* for more details and examples.
*/
listGlossaries(
Expand Down Expand Up @@ -1886,7 +1886,7 @@ export class TranslationServiceClient {
* We recommend using `listGlossariesAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination| documentation}
* for more details and examples.
*/
listGlossariesStream(
Expand Down Expand Up @@ -1947,12 +1947,12 @@ export class TranslationServiceClient {
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols| async iteration}.
* When you iterate the returned iterable, each element will be an object representing
* [Glossary]{@link google.cloud.translation.v3.Glossary}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination| documentation}
* for more details and examples.
* @example
* const iterable = client.listGlossariesAsync(request);
Expand Down
Loading

0 comments on commit ccbba86

Please sign in to comment.