Skip to content

Commit

Permalink
chore(cloud-rad): Add code fencing (#641)
Browse files Browse the repository at this point in the history
## Code fencing
Code examples need code fencing around them to distingish from
rich text for TSDoc.

Internally b/179483748

Script used:
https://github.com/fhinkel/cloud-rad-script/blob/main/fixExampleComments.js
  • Loading branch information
fhinkel authored Nov 12, 2021
1 parent 5f9d9f1 commit 37614a4
Show file tree
Hide file tree
Showing 78 changed files with 1,148 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,9 @@ export class AcceleratorTypesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example
* ```
* const [response] = await client.get(request);
* ```
*/
get(
request?: protos.google.cloud.compute.v1.IGetAcceleratorTypeRequest,
Expand Down Expand Up @@ -453,10 +455,12 @@ export class AcceleratorTypesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.aggregatedListAsync(request);
* for await (const [key, value] of iterable) {
* // process response
* }
* ```
*/
aggregatedListAsync(
request?: protos.google.cloud.compute.v1.IAggregatedListAcceleratorTypesRequest,
Expand Down Expand Up @@ -696,10 +700,12 @@ export class AcceleratorTypesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.listAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listAsync(
request?: protos.google.cloud.compute.v1.IListAcceleratorTypesRequest,
Expand Down
10 changes: 10 additions & 0 deletions packages/google-cloud-compute/src/v1/addresses_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,9 @@ export class AddressesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.delete(request);
* ```
*/
delete(
request?: protos.google.cloud.compute.v1.IDeleteAddressRequest,
Expand Down Expand Up @@ -485,7 +487,9 @@ export class AddressesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example
* ```
* const [response] = await client.get(request);
* ```
*/
get(
request?: protos.google.cloud.compute.v1.IGetAddressRequest,
Expand Down Expand Up @@ -583,7 +587,9 @@ export class AddressesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.insert(request);
* ```
*/
insert(
request?: protos.google.cloud.compute.v1.IInsertAddressRequest,
Expand Down Expand Up @@ -688,10 +694,12 @@ export class AddressesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.aggregatedListAsync(request);
* for await (const [key, value] of iterable) {
* // process response
* }
* ```
*/
aggregatedListAsync(
request?: protos.google.cloud.compute.v1.IAggregatedListAddressesRequest,
Expand Down Expand Up @@ -929,10 +937,12 @@ export class AddressesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.listAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listAsync(
request?: protos.google.cloud.compute.v1.IListAddressesRequest,
Expand Down
14 changes: 14 additions & 0 deletions packages/google-cloud-compute/src/v1/autoscalers_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,9 @@ export class AutoscalersClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.delete(request);
* ```
*/
delete(
request?: protos.google.cloud.compute.v1.IDeleteAutoscalerRequest,
Expand Down Expand Up @@ -493,7 +495,9 @@ export class AutoscalersClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example
* ```
* const [response] = await client.get(request);
* ```
*/
get(
request?: protos.google.cloud.compute.v1.IGetAutoscalerRequest,
Expand Down Expand Up @@ -597,7 +601,9 @@ export class AutoscalersClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.insert(request);
* ```
*/
insert(
request?: protos.google.cloud.compute.v1.IInsertAutoscalerRequest,
Expand Down Expand Up @@ -721,7 +727,9 @@ export class AutoscalersClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.patch(request);
* ```
*/
patch(
request?: protos.google.cloud.compute.v1.IPatchAutoscalerRequest,
Expand Down Expand Up @@ -847,7 +855,9 @@ export class AutoscalersClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.update(request);
* ```
*/
update(
request?: protos.google.cloud.compute.v1.IUpdateAutoscalerRequest,
Expand Down Expand Up @@ -954,10 +964,12 @@ export class AutoscalersClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.aggregatedListAsync(request);
* for await (const [key, value] of iterable) {
* // process response
* }
* ```
*/
aggregatedListAsync(
request?: protos.google.cloud.compute.v1.IAggregatedListAutoscalersRequest,
Expand Down Expand Up @@ -1195,10 +1207,12 @@ export class AutoscalersClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.listAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listAsync(
request?: protos.google.cloud.compute.v1.IListAutoscalersRequest,
Expand Down
16 changes: 16 additions & 0 deletions packages/google-cloud-compute/src/v1/backend_buckets_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,9 @@ export class BackendBucketsClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.addSignedUrlKey(request);
* ```
*/
addSignedUrlKey(
request?: protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendBucketRequest,
Expand Down Expand Up @@ -502,7 +504,9 @@ export class BackendBucketsClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.delete(request);
* ```
*/
delete(
request?: protos.google.cloud.compute.v1.IDeleteBackendBucketRequest,
Expand Down Expand Up @@ -628,7 +632,9 @@ export class BackendBucketsClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.deleteSignedUrlKey(request);
* ```
*/
deleteSignedUrlKey(
request?: protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendBucketRequest,
Expand Down Expand Up @@ -741,7 +747,9 @@ export class BackendBucketsClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example
* ```
* const [response] = await client.get(request);
* ```
*/
get(
request?: protos.google.cloud.compute.v1.IGetBackendBucketRequest,
Expand Down Expand Up @@ -845,7 +853,9 @@ export class BackendBucketsClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.insert(request);
* ```
*/
insert(
request?: protos.google.cloud.compute.v1.IInsertBackendBucketRequest,
Expand Down Expand Up @@ -971,7 +981,9 @@ export class BackendBucketsClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.patch(request);
* ```
*/
patch(
request?: protos.google.cloud.compute.v1.IPatchBackendBucketRequest,
Expand Down Expand Up @@ -1097,7 +1109,9 @@ export class BackendBucketsClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.update(request);
* ```
*/
update(
request?: protos.google.cloud.compute.v1.IUpdateBackendBucketRequest,
Expand Down Expand Up @@ -1368,10 +1382,12 @@ export class BackendBucketsClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.listAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listAsync(
request?: protos.google.cloud.compute.v1.IListBackendBucketsRequest,
Expand Down
22 changes: 22 additions & 0 deletions packages/google-cloud-compute/src/v1/backend_services_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,9 @@ export class BackendServicesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.addSignedUrlKey(request);
* ```
*/
addSignedUrlKey(
request?: protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest,
Expand Down Expand Up @@ -510,7 +512,9 @@ export class BackendServicesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.delete(request);
* ```
*/
delete(
request?: protos.google.cloud.compute.v1.IDeleteBackendServiceRequest,
Expand Down Expand Up @@ -636,7 +640,9 @@ export class BackendServicesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.deleteSignedUrlKey(request);
* ```
*/
deleteSignedUrlKey(
request?: protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest,
Expand Down Expand Up @@ -749,7 +755,9 @@ export class BackendServicesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example
* ```
* const [response] = await client.get(request);
* ```
*/
get(
request?: protos.google.cloud.compute.v1.IGetBackendServiceRequest,
Expand Down Expand Up @@ -850,7 +858,9 @@ export class BackendServicesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
* for more details and examples.
* @example
* ```
* const [response] = await client.getHealth(request);
* ```
*/
getHealth(
request?: protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest,
Expand Down Expand Up @@ -957,7 +967,9 @@ export class BackendServicesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.insert(request);
* ```
*/
insert(
request?: protos.google.cloud.compute.v1.IInsertBackendServiceRequest,
Expand Down Expand Up @@ -1083,7 +1095,9 @@ export class BackendServicesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.patch(request);
* ```
*/
patch(
request?: protos.google.cloud.compute.v1.IPatchBackendServiceRequest,
Expand Down Expand Up @@ -1209,7 +1223,9 @@ export class BackendServicesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.setSecurityPolicy(request);
* ```
*/
setSecurityPolicy(
request?: protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest,
Expand Down Expand Up @@ -1335,7 +1351,9 @@ export class BackendServicesClient {
* and might get backwards-incompatible changes at any time.
* `.promise()` is not supported yet.
* @example
* ```
* const [operation] = await client.update(request);
* ```
*/
update(
request?: protos.google.cloud.compute.v1.IUpdateBackendServiceRequest,
Expand Down Expand Up @@ -1442,10 +1460,12 @@ export class BackendServicesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.aggregatedListAsync(request);
* for await (const [key, value] of iterable) {
* // process response
* }
* ```
*/
aggregatedListAsync(
request?: protos.google.cloud.compute.v1.IAggregatedListBackendServicesRequest,
Expand Down Expand Up @@ -1677,10 +1697,12 @@ export class BackendServicesClient {
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
* for more details and examples.
* @example
* ```
* const iterable = client.listAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listAsync(
request?: protos.google.cloud.compute.v1.IListBackendServicesRequest,
Expand Down
Loading

0 comments on commit 37614a4

Please sign in to comment.