chore(cloud-rad): add code fencing for TSDoc (#1689)

fhinkel · web-flow · commit 57bb18092b43 · 2021-10-29T11:11:36.000-07:00
Instead of `<caption>` use rich text for examples. See #1679
diff --git a/src/bucket.ts b/src/bucket.ts
@@ -2129,18 +2129,24 @@ class Bucket extends ServiceObject {
    * });
    *
    * ```
-   * @example <caption>Optionally, provide a destination bucket.</caption>
+   * @example
+   * Optionally, provide a destination bucket.
+   * ```
    * const config = {
    *   prefix: 'log',
    *   bucket: 'destination-bucket'
    * };
    *
    * bucket.enableLogging(config, function(err, apiResponse) {});
+   * ```
    *
-   * @example <caption>If the callback is omitted, we'll return a Promise.</caption>
+   * @example
+   * If the callback is omitted, we'll return a Promise.
+   * ```
    * bucket.enableLogging(config).then(function(data) {
    *   const apiResponse = data[0];
    * });
+   * ```
    */
   enableLogging(
     config: EnableLoggingOptions,
@@ -2440,7 +2446,9 @@ class Bucket extends ServiceObject {
    * });
    *
    * ```
-   * @example <caption><h6>Simulating a File System</h6><p>With `autoPaginate: false`, it's possible to iterate over files which incorporate a common structure using a delimiter.</p><p>Consider the following remote objects:</p><ol><li>"a"</li><li>"a/b/c/d"</li><li>"b/d/e"</li></ol><p>Using a delimiter of `/` will return a single file, "a".</p><p>`apiResponse.prefixes` will return the "sub-directories" that were found:</p><ol><li>"a/"</li><li>"b/"</li></ol></caption>
+   * @example
+   * <h6>Simulating a File System</h6><p>With `autoPaginate: false`, it's possible to iterate over files which incorporate a common structure using a delimiter.</p><p>Consider the following remote objects:</p><ol><li>"a"</li><li>"a/b/c/d"</li><li>"b/d/e"</li></ol><p>Using a delimiter of `/` will return a single file, "a".</p><p>`apiResponse.prefixes` will return the "sub-directories" that were found:</p><ol><li>"a/"</li><li>"b/"</li></ol>
+   * ```
    * bucket.getFiles({
    *   autoPaginate: false,
    *   delimiter: '/'
@@ -2454,8 +2462,11 @@ class Bucket extends ServiceObject {
    *   //   'b/'
    *   // ]
    * });
+   * ```
    *
-   * @example <caption>Using prefixes, it's now possible to simulate a file system with follow-up requests.</caption>
+   * @example
+   * Using prefixes, it's now possible to simulate a file system with follow-up requests.
+   * ```
    * bucket.getFiles({
    *   autoPaginate: false,
    *   delimiter: '/',
@@ -2470,6 +2481,7 @@ class Bucket extends ServiceObject {
    *   //   'a/b/'
    *   // ]
    * });
+   * ```
    *
    * @example <caption>include:samples/files.js</caption>
    * region_tag:storage_list_files
diff --git a/src/index.ts b/src/index.ts
@@ -22,22 +22,35 @@
  * @module {Storage} @google-cloud/storage
  * @alias nodejs-storage
  *
- * @example <caption>Install the client library with <a
- * href="https://www.npmjs.com/">npm</a>:</caption> npm install --save
- * @google-cloud/storage
+ * @example
+ * Install the client library with <a href="https://www.npmjs.com/">npm</a>:
+ * ```
+ * npm install --save @google-cloud/storage
+ * ```
  *
- * @example <caption>Import the client library</caption>
+ * @example
+ * Import the client library
+ * ```
  * const {Storage} = require('@google-cloud/storage');
+ * ```
  *
- * @example <caption>Create a client that uses <a
+ * @example
+ * Create a client that uses <a
  * href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application
- * Default Credentials (ADC)</a>:</caption> const storage = new Storage();
+ * Default Credentials (ADC)</a>:
+ * ```
+ * const storage = new Storage();
+ * ```
  *
- * @example <caption>Create a client with <a
+ * @example
+ * Create a client with <a
  * href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit
- * credentials</a>:</caption> const storage = new Storage({ projectId:
+ * credentials</a>:
+ * ```
+ * const storage = new Storage({ projectId:
  * 'your-project-id', keyFilename: '/path/to/keyfile.json'
  * });
+ * ```
  *
  * @example <caption>include:samples/quickstart.js</caption>
  * region_tag:storage_quickstart
diff --git a/src/storage.ts b/src/storage.ts
@@ -528,17 +528,23 @@ export class Storage extends Service {
   /**
    * Constructs the Storage client.
    *
-   * @example <caption>Create a client that uses Application Default Credentials
-   * (ADC)</caption>
+   * @example
+   * Create a client that uses Application Default Credentials
+   * (ADC)
+   * ```
    * const {Storage} = require('@google-cloud/storage');
    * const storage = new Storage();
+   * ```
    *
-   * @example <caption>Create a client with explicit credentials</caption>
+   * @example
+   * Create a client with explicit credentials
+   * ```
    * const storage = new Storage({
    *   projectId: 'your-project-id',
    *   keyFilename: '/path/to/keyfile.json'
    * });
-   *
+   * ```
+
    * @param {StorageOptions} [options] Configuration options.
    */
   constructor(options: StorageOptions = {}) {
