Skip to content

Commit 37614a4

Browse files
authored
chore(cloud-rad): Add code fencing (#641)
## 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
1 parent 5f9d9f1 commit 37614a4

File tree

78 files changed

+1148
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+1148
-0
lines changed

packages/google-cloud-compute/src/v1/accelerator_types_client.ts

+6
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,9 @@ export class AcceleratorTypesClient {
366366
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
367367
* for more details and examples.
368368
* @example
369+
* ```
369370
* const [response] = await client.get(request);
371+
* ```
370372
*/
371373
get(
372374
request?: protos.google.cloud.compute.v1.IGetAcceleratorTypeRequest,
@@ -453,10 +455,12 @@ export class AcceleratorTypesClient {
453455
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
454456
* for more details and examples.
455457
* @example
458+
* ```
456459
* const iterable = client.aggregatedListAsync(request);
457460
* for await (const [key, value] of iterable) {
458461
* // process response
459462
* }
463+
* ```
460464
*/
461465
aggregatedListAsync(
462466
request?: protos.google.cloud.compute.v1.IAggregatedListAcceleratorTypesRequest,
@@ -696,10 +700,12 @@ export class AcceleratorTypesClient {
696700
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
697701
* for more details and examples.
698702
* @example
703+
* ```
699704
* const iterable = client.listAsync(request);
700705
* for await (const response of iterable) {
701706
* // process response
702707
* }
708+
* ```
703709
*/
704710
listAsync(
705711
request?: protos.google.cloud.compute.v1.IListAcceleratorTypesRequest,

packages/google-cloud-compute/src/v1/addresses_client.ts

+10
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,9 @@ export class AddressesClient {
376376
* and might get backwards-incompatible changes at any time.
377377
* `.promise()` is not supported yet.
378378
* @example
379+
* ```
379380
* const [operation] = await client.delete(request);
381+
* ```
380382
*/
381383
delete(
382384
request?: protos.google.cloud.compute.v1.IDeleteAddressRequest,
@@ -485,7 +487,9 @@ export class AddressesClient {
485487
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
486488
* for more details and examples.
487489
* @example
490+
* ```
488491
* const [response] = await client.get(request);
492+
* ```
489493
*/
490494
get(
491495
request?: protos.google.cloud.compute.v1.IGetAddressRequest,
@@ -583,7 +587,9 @@ export class AddressesClient {
583587
* and might get backwards-incompatible changes at any time.
584588
* `.promise()` is not supported yet.
585589
* @example
590+
* ```
586591
* const [operation] = await client.insert(request);
592+
* ```
587593
*/
588594
insert(
589595
request?: protos.google.cloud.compute.v1.IInsertAddressRequest,
@@ -688,10 +694,12 @@ export class AddressesClient {
688694
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
689695
* for more details and examples.
690696
* @example
697+
* ```
691698
* const iterable = client.aggregatedListAsync(request);
692699
* for await (const [key, value] of iterable) {
693700
* // process response
694701
* }
702+
* ```
695703
*/
696704
aggregatedListAsync(
697705
request?: protos.google.cloud.compute.v1.IAggregatedListAddressesRequest,
@@ -929,10 +937,12 @@ export class AddressesClient {
929937
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
930938
* for more details and examples.
931939
* @example
940+
* ```
932941
* const iterable = client.listAsync(request);
933942
* for await (const response of iterable) {
934943
* // process response
935944
* }
945+
* ```
936946
*/
937947
listAsync(
938948
request?: protos.google.cloud.compute.v1.IListAddressesRequest,

packages/google-cloud-compute/src/v1/autoscalers_client.ts

+14
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,9 @@ export class AutoscalersClient {
382382
* and might get backwards-incompatible changes at any time.
383383
* `.promise()` is not supported yet.
384384
* @example
385+
* ```
385386
* const [operation] = await client.delete(request);
387+
* ```
386388
*/
387389
delete(
388390
request?: protos.google.cloud.compute.v1.IDeleteAutoscalerRequest,
@@ -493,7 +495,9 @@ export class AutoscalersClient {
493495
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
494496
* for more details and examples.
495497
* @example
498+
* ```
496499
* const [response] = await client.get(request);
500+
* ```
497501
*/
498502
get(
499503
request?: protos.google.cloud.compute.v1.IGetAutoscalerRequest,
@@ -597,7 +601,9 @@ export class AutoscalersClient {
597601
* and might get backwards-incompatible changes at any time.
598602
* `.promise()` is not supported yet.
599603
* @example
604+
* ```
600605
* const [operation] = await client.insert(request);
606+
* ```
601607
*/
602608
insert(
603609
request?: protos.google.cloud.compute.v1.IInsertAutoscalerRequest,
@@ -721,7 +727,9 @@ export class AutoscalersClient {
721727
* and might get backwards-incompatible changes at any time.
722728
* `.promise()` is not supported yet.
723729
* @example
730+
* ```
724731
* const [operation] = await client.patch(request);
732+
* ```
725733
*/
726734
patch(
727735
request?: protos.google.cloud.compute.v1.IPatchAutoscalerRequest,
@@ -847,7 +855,9 @@ export class AutoscalersClient {
847855
* and might get backwards-incompatible changes at any time.
848856
* `.promise()` is not supported yet.
849857
* @example
858+
* ```
850859
* const [operation] = await client.update(request);
860+
* ```
851861
*/
852862
update(
853863
request?: protos.google.cloud.compute.v1.IUpdateAutoscalerRequest,
@@ -954,10 +964,12 @@ export class AutoscalersClient {
954964
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
955965
* for more details and examples.
956966
* @example
967+
* ```
957968
* const iterable = client.aggregatedListAsync(request);
958969
* for await (const [key, value] of iterable) {
959970
* // process response
960971
* }
972+
* ```
961973
*/
962974
aggregatedListAsync(
963975
request?: protos.google.cloud.compute.v1.IAggregatedListAutoscalersRequest,
@@ -1195,10 +1207,12 @@ export class AutoscalersClient {
11951207
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
11961208
* for more details and examples.
11971209
* @example
1210+
* ```
11981211
* const iterable = client.listAsync(request);
11991212
* for await (const response of iterable) {
12001213
* // process response
12011214
* }
1215+
* ```
12021216
*/
12031217
listAsync(
12041218
request?: protos.google.cloud.compute.v1.IListAutoscalersRequest,

packages/google-cloud-compute/src/v1/backend_buckets_client.ts

+16
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,9 @@ export class BackendBucketsClient {
378378
* and might get backwards-incompatible changes at any time.
379379
* `.promise()` is not supported yet.
380380
* @example
381+
* ```
381382
* const [operation] = await client.addSignedUrlKey(request);
383+
* ```
382384
*/
383385
addSignedUrlKey(
384386
request?: protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendBucketRequest,
@@ -502,7 +504,9 @@ export class BackendBucketsClient {
502504
* and might get backwards-incompatible changes at any time.
503505
* `.promise()` is not supported yet.
504506
* @example
507+
* ```
505508
* const [operation] = await client.delete(request);
509+
* ```
506510
*/
507511
delete(
508512
request?: protos.google.cloud.compute.v1.IDeleteBackendBucketRequest,
@@ -628,7 +632,9 @@ export class BackendBucketsClient {
628632
* and might get backwards-incompatible changes at any time.
629633
* `.promise()` is not supported yet.
630634
* @example
635+
* ```
631636
* const [operation] = await client.deleteSignedUrlKey(request);
637+
* ```
632638
*/
633639
deleteSignedUrlKey(
634640
request?: protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendBucketRequest,
@@ -741,7 +747,9 @@ export class BackendBucketsClient {
741747
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
742748
* for more details and examples.
743749
* @example
750+
* ```
744751
* const [response] = await client.get(request);
752+
* ```
745753
*/
746754
get(
747755
request?: protos.google.cloud.compute.v1.IGetBackendBucketRequest,
@@ -845,7 +853,9 @@ export class BackendBucketsClient {
845853
* and might get backwards-incompatible changes at any time.
846854
* `.promise()` is not supported yet.
847855
* @example
856+
* ```
848857
* const [operation] = await client.insert(request);
858+
* ```
849859
*/
850860
insert(
851861
request?: protos.google.cloud.compute.v1.IInsertBackendBucketRequest,
@@ -971,7 +981,9 @@ export class BackendBucketsClient {
971981
* and might get backwards-incompatible changes at any time.
972982
* `.promise()` is not supported yet.
973983
* @example
984+
* ```
974985
* const [operation] = await client.patch(request);
986+
* ```
975987
*/
976988
patch(
977989
request?: protos.google.cloud.compute.v1.IPatchBackendBucketRequest,
@@ -1097,7 +1109,9 @@ export class BackendBucketsClient {
10971109
* and might get backwards-incompatible changes at any time.
10981110
* `.promise()` is not supported yet.
10991111
* @example
1112+
* ```
11001113
* const [operation] = await client.update(request);
1114+
* ```
11011115
*/
11021116
update(
11031117
request?: protos.google.cloud.compute.v1.IUpdateBackendBucketRequest,
@@ -1368,10 +1382,12 @@ export class BackendBucketsClient {
13681382
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
13691383
* for more details and examples.
13701384
* @example
1385+
* ```
13711386
* const iterable = client.listAsync(request);
13721387
* for await (const response of iterable) {
13731388
* // process response
13741389
* }
1390+
* ```
13751391
*/
13761392
listAsync(
13771393
request?: protos.google.cloud.compute.v1.IListBackendBucketsRequest,

packages/google-cloud-compute/src/v1/backend_services_client.ts

+22
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,9 @@ export class BackendServicesClient {
386386
* and might get backwards-incompatible changes at any time.
387387
* `.promise()` is not supported yet.
388388
* @example
389+
* ```
389390
* const [operation] = await client.addSignedUrlKey(request);
391+
* ```
390392
*/
391393
addSignedUrlKey(
392394
request?: protos.google.cloud.compute.v1.IAddSignedUrlKeyBackendServiceRequest,
@@ -510,7 +512,9 @@ export class BackendServicesClient {
510512
* and might get backwards-incompatible changes at any time.
511513
* `.promise()` is not supported yet.
512514
* @example
515+
* ```
513516
* const [operation] = await client.delete(request);
517+
* ```
514518
*/
515519
delete(
516520
request?: protos.google.cloud.compute.v1.IDeleteBackendServiceRequest,
@@ -636,7 +640,9 @@ export class BackendServicesClient {
636640
* and might get backwards-incompatible changes at any time.
637641
* `.promise()` is not supported yet.
638642
* @example
643+
* ```
639644
* const [operation] = await client.deleteSignedUrlKey(request);
645+
* ```
640646
*/
641647
deleteSignedUrlKey(
642648
request?: protos.google.cloud.compute.v1.IDeleteSignedUrlKeyBackendServiceRequest,
@@ -749,7 +755,9 @@ export class BackendServicesClient {
749755
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
750756
* for more details and examples.
751757
* @example
758+
* ```
752759
* const [response] = await client.get(request);
760+
* ```
753761
*/
754762
get(
755763
request?: protos.google.cloud.compute.v1.IGetBackendServiceRequest,
@@ -850,7 +858,9 @@ export class BackendServicesClient {
850858
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
851859
* for more details and examples.
852860
* @example
861+
* ```
853862
* const [response] = await client.getHealth(request);
863+
* ```
854864
*/
855865
getHealth(
856866
request?: protos.google.cloud.compute.v1.IGetHealthBackendServiceRequest,
@@ -957,7 +967,9 @@ export class BackendServicesClient {
957967
* and might get backwards-incompatible changes at any time.
958968
* `.promise()` is not supported yet.
959969
* @example
970+
* ```
960971
* const [operation] = await client.insert(request);
972+
* ```
961973
*/
962974
insert(
963975
request?: protos.google.cloud.compute.v1.IInsertBackendServiceRequest,
@@ -1083,7 +1095,9 @@ export class BackendServicesClient {
10831095
* and might get backwards-incompatible changes at any time.
10841096
* `.promise()` is not supported yet.
10851097
* @example
1098+
* ```
10861099
* const [operation] = await client.patch(request);
1100+
* ```
10871101
*/
10881102
patch(
10891103
request?: protos.google.cloud.compute.v1.IPatchBackendServiceRequest,
@@ -1209,7 +1223,9 @@ export class BackendServicesClient {
12091223
* and might get backwards-incompatible changes at any time.
12101224
* `.promise()` is not supported yet.
12111225
* @example
1226+
* ```
12121227
* const [operation] = await client.setSecurityPolicy(request);
1228+
* ```
12131229
*/
12141230
setSecurityPolicy(
12151231
request?: protos.google.cloud.compute.v1.ISetSecurityPolicyBackendServiceRequest,
@@ -1335,7 +1351,9 @@ export class BackendServicesClient {
13351351
* and might get backwards-incompatible changes at any time.
13361352
* `.promise()` is not supported yet.
13371353
* @example
1354+
* ```
13381355
* const [operation] = await client.update(request);
1356+
* ```
13391357
*/
13401358
update(
13411359
request?: protos.google.cloud.compute.v1.IUpdateBackendServiceRequest,
@@ -1442,10 +1460,12 @@ export class BackendServicesClient {
14421460
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
14431461
* for more details and examples.
14441462
* @example
1463+
* ```
14451464
* const iterable = client.aggregatedListAsync(request);
14461465
* for await (const [key, value] of iterable) {
14471466
* // process response
14481467
* }
1468+
* ```
14491469
*/
14501470
aggregatedListAsync(
14511471
request?: protos.google.cloud.compute.v1.IAggregatedListBackendServicesRequest,
@@ -1677,10 +1697,12 @@ export class BackendServicesClient {
16771697
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
16781698
* for more details and examples.
16791699
* @example
1700+
* ```
16801701
* const iterable = client.listAsync(request);
16811702
* for await (const response of iterable) {
16821703
* // process response
16831704
* }
1705+
* ```
16841706
*/
16851707
listAsync(
16861708
request?: protos.google.cloud.compute.v1.IListBackendServicesRequest,

0 commit comments

Comments
 (0)