Skip to content

Commit ebfe403

Browse files
stephenpluspluscallmehiphop
stephenplusplus
authored and
callmehiphop
committed
docs: remove nextQuery docs & annotate arrays correctly (#1559)
1 parent 16a16f1 commit ebfe403

File tree

5 files changed

+27
-82
lines changed

5 files changed

+27
-82
lines changed

‎packages/google-cloud-compute/src/index.js

Lines changed: 17 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -579,10 +579,8 @@ Compute.prototype.firewall = function(name) {
579579
* representing part of the larger set of results to view.
580580
* @param {function} callback - The callback function.
581581
* @param {?error} callback.err - An error returned while making this request.
582-
* @param {module:compute/address} callback.addresses - Address objects from
582+
* @param {module:compute/address[]} callback.addresses - Address objects from
583583
* your project.
584-
* @param {?object} callback.nextQuery - If present, query with this object to
585-
* check for more results.
586584
* @param {object} callback.apiResponse - The full API response.
587585
*
588586
* @example
@@ -698,8 +696,6 @@ Compute.prototype.getAddresses = function(options, callback) {
698696
* @param {?error} callback.err - An error returned while making this request.
699697
* @param {module:compute/autoscaler[]} callback.autoscalers - Autoscaler
700698
* objects from your project.
701-
* @param {?object} callback.nextQuery - If present, query with this object to
702-
* check for more results.
703699
* @param {object} callback.apiResponse - The full API response.
704700
*
705701
* @example
@@ -815,9 +811,8 @@ Compute.prototype.getAutoscalers = function(options, callback) {
815811
* representing part of the larger set of results to view.
816812
* @param {function} callback - The callback function.
817813
* @param {?error} callback.err - An error returned while making this request.
818-
* @param {module:compute/disk} callback.disks - Disk objects from your project.
819-
* @param {?object} callback.nextQuery - If present, query with this object to
820-
* check for more results.
814+
* @param {module:compute/disk[]} callback.disks - Disk objects from your
815+
* project.
821816
* @param {object} callback.apiResponse - The full API response.
822817
*
823818
* @example
@@ -932,8 +927,6 @@ Compute.prototype.getDisks = function(options, callback) {
932927
* @param {?error} callback.err - An error returned while making this request.
933928
* @param {module:compute/instance-group[]} callback.instanceGroups -
934929
* InstanceGroup objects from your project.
935-
* @param {?object} callback.nextQuery - If present, query with this object to
936-
* check for more results.
937930
* @param {object} callback.apiResponse - The full API response.
938931
*
939932
* @example
@@ -1045,10 +1038,8 @@ Compute.prototype.getInstanceGroups = function(options, callback) {
10451038
* representing part of the larger set of results to view.
10461039
* @param {function} callback - The callback function.
10471040
* @param {?error} callback.err - An error returned while making this request.
1048-
* @param {module:compute/firewall} callback.firewalls - Firewall objects from
1041+
* @param {module:compute/firewall[]} callback.firewalls - Firewall objects from
10491042
* your project.
1050-
* @param {?object} callback.nextQuery - If present, query with this object to
1051-
* check for more results.
10521043
* @param {object} callback.apiResponse - The full API response.
10531044
*
10541045
* @example
@@ -1154,10 +1145,8 @@ Compute.prototype.getFirewalls = function(options, callback) {
11541145
* representing part of the larger set of results to view.
11551146
* @param {function} callback - The callback function.
11561147
* @param {?error} callback.err - An error returned while making this request.
1157-
* @param {module:compute/health-check} callback.healthChecks - HealthCheck
1148+
* @param {module:compute/health-check[]} callback.healthChecks - HealthCheck
11581149
* objects from your project.
1159-
* @param {?object} callback.nextQuery - If present, query with this object to
1160-
* check for more results.
11611150
* @param {object} callback.apiResponse - The full API response.
11621151
*
11631152
* @example
@@ -1269,8 +1258,6 @@ Compute.prototype.getHealthChecks = function(options, callback) {
12691258
* @param {?error} callback.err - An error returned while making this request.
12701259
* @param {module:compute/machine-type[]} callback.machineTypes - MachineType
12711260
* objects from your project.
1272-
* @param {?object} callback.nextQuery - If present, query with this object to
1273-
* check for more results.
12741261
* @param {object} callback.apiResponse - The full API response.
12751262
*
12761263
* @example
@@ -1382,10 +1369,8 @@ Compute.prototype.getMachineTypes = function(options, callback) {
13821369
* representing part of the larger set of results to view.
13831370
* @param {function} callback - The callback function.
13841371
* @param {?error} callback.err - An error returned while making this request.
1385-
* @param {module:compute/network} callback.networks - Network objects from your
1386-
* project.
1387-
* @param {?object} callback.nextQuery - If present, query with this object to
1388-
* check for more results.
1372+
* @param {module:compute/network[]} callback.networks - Network objects from
1373+
* your project.
13891374
* @param {object} callback.apiResponse - The full API response.
13901375
*
13911376
* @example
@@ -1488,10 +1473,8 @@ Compute.prototype.getNetworks = function(options, callback) {
14881473
* representing part of the larger set of results to view.
14891474
* @param {function} callback - The callback function.
14901475
* @param {?error} callback.err - An error returned while making this request.
1491-
* @param {module:compute/operation} callback.operations - Operation objects
1476+
* @param {module:compute/operation[]} callback.operations - Operation objects
14921477
* from your project.
1493-
* @param {?object} callback.nextQuery - If present, query with this object to
1494-
* check for more results.
14951478
* @param {object} callback.apiResponse - The full API response.
14961479
*
14971480
* @example
@@ -1594,10 +1577,8 @@ Compute.prototype.getOperations = function(options, callback) {
15941577
* representing part of the larger set of results to view.
15951578
* @param {function} callback - The callback function.
15961579
* @param {?error} callback.err - An error returned while making this request.
1597-
* @param {module:compute/region} callback.regions - Region objects that are
1580+
* @param {module:compute/region[]} callback.regions - Region objects that are
15981581
* available to your project.
1599-
* @param {?object} callback.nextQuery - If present, query with this object to
1600-
* check for more results.
16011582
* @param {object} callback.apiResponse - The full API response.
16021583
*
16031584
* @example
@@ -1697,9 +1678,8 @@ Compute.prototype.getRegions = function(options, callback) {
16971678
* representing part of the larger set of results to view.
16981679
* @param {function} callback - The callback function.
16991680
* @param {?error} callback.err - An error returned while making this request.
1700-
* @param {module:compute/rule} callback.rules - Rule objects from this region.
1701-
* @param {?object} callback.nextQuery - If present, query with this object to
1702-
* check for more results.
1681+
* @param {module:compute/rule[]} callback.rules - Rule objects from your
1682+
* project.
17031683
* @param {object} callback.apiResponse - The full API response.
17041684
*
17051685
* @example
@@ -1804,8 +1784,6 @@ Compute.prototype.getRules = function(options, callback) {
18041784
* @param {?error} callback.err - An error returned while making this request.
18051785
* @param {module:compute/service[]} callback.services - Service objects from
18061786
* your project.
1807-
* @param {?object} callback.nextQuery - If present, query with this object to
1808-
* check for more results.
18091787
* @param {object} callback.apiResponse - The full API response.
18101788
*
18111789
* @example
@@ -1908,10 +1886,8 @@ Compute.prototype.getServices = function(options, callback) {
19081886
* representing part of the larger set of results to view.
19091887
* @param {function} callback - The callback function.
19101888
* @param {?error} callback.err - An error returned while making this request.
1911-
* @param {module:compute/snapshot} callback.snapshots - Snapshot objects from
1889+
* @param {module:compute/snapshot[]} callback.snapshots - Snapshot objects from
19121890
* your project.
1913-
* @param {?object} callback.nextQuery - If present, query with this object to
1914-
* check for more results.
19151891
* @param {object} callback.apiResponse - The full API response.
19161892
*
19171893
* @example
@@ -2014,10 +1990,8 @@ Compute.prototype.getSnapshots = function(options, callback) {
20141990
* representing part of the larger set of results to view.
20151991
* @param {function} callback - The callback function.
20161992
* @param {?error} callback.err - An error returned while making this request.
2017-
* @param {module:compute/subnetwork} callback.subnetworks - Subnetwork objects
2018-
* from your project.
2019-
* @param {?object} callback.nextQuery - If present, query with this object to
2020-
* check for more results.
1993+
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
1994+
* objects from your project.
20211995
* @param {object} callback.apiResponse - The full API response.
20221996
*
20231997
* @example
@@ -2129,9 +2103,7 @@ Compute.prototype.getSubnetworks = function(options, callback) {
21292103
* representing part of the larger set of results to view.
21302104
* @param {function} callback - The callback function.
21312105
* @param {?error} callback.err - An error returned while making this request.
2132-
* @param {module:compute/vm} callback.vms - VM objects from your project.
2133-
* @param {?object} callback.nextQuery - If present, query with this object to
2134-
* check for more results.
2106+
* @param {module:compute/vm[]} callback.vms - VM objects from your project.
21352107
* @param {object} callback.apiResponse - The full API response.
21362108
*
21372109
* @example
@@ -2243,10 +2215,8 @@ Compute.prototype.getVMs = function(options, callback) {
22432215
* representing part of the larger set of results to view.
22442216
* @param {function} callback - The callback function.
22452217
* @param {?error} callback.err - An error returned while making this request.
2246-
* @param {module:compute/zone} callback.zones - Zone objects that are available
2247-
* to your project.
2248-
* @param {?object} callback.nextQuery - If present, query with this object to
2249-
* check for more results.
2218+
* @param {module:compute/zone[]} callback.zones - Zone objects that are
2219+
* available to your project.
22502220
* @param {object} callback.apiResponse - The full API response.
22512221
*
22522222
* @example

‎packages/google-cloud-compute/src/instance-group.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,6 @@ InstanceGroup.prototype.delete = function(callback) {
258258
* @param {?error} callback.err - An error returned while making this request.
259259
* @param {module:compute/vm[]} callback.vms - VM objects from this isntance
260260
* group.
261-
* @param {?object} callback.nextQuery - If present, query with this object to
262-
* check for more results.
263261
* @param {object} callback.apiResponse - The full API response.
264262
*
265263
* @example

‎packages/google-cloud-compute/src/network.js

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -275,10 +275,8 @@ Network.prototype.createSubnetwork = function(name, config, callback) {
275275
* representing part of the larger set of results to view.
276276
* @param {function} callback - The callback function.
277277
* @param {?error} callback.err - An error returned while making this request.
278-
* @param {module:compute/subnetwork} callback.subnetworks - Subnetwork objects
279-
* from this network.
280-
* @param {?object} callback.nextQuery - If present, query with this object to
281-
* check for more results.
278+
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
279+
* objects from this network.
282280
* @param {object} callback.apiResponse - The full API response.
283281
*
284282
* @example
@@ -405,10 +403,8 @@ Network.prototype.firewall = function(name) {
405403
* representing part of the larger set of results to view.
406404
* @param {function} callback - The callback function.
407405
* @param {?error} callback.err - An error returned while making this request.
408-
* @param {module:compute/firewall} callback.firewalls - Firewall objects from
406+
* @param {module:compute/firewall[]} callback.firewalls - Firewall objects from
409407
* this network.
410-
* @param {?object} callback.nextQuery - If present, query with this object to
411-
* check for more results.
412408
* @param {object} callback.apiResponse - The full API response.
413409
*
414410
* @example

‎packages/google-cloud-compute/src/region.js

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -356,10 +356,8 @@ Region.prototype.createRule = function(name, config, callback) {
356356
* representing part of the larger set of results to view.
357357
* @param {function} callback - The callback function.
358358
* @param {?error} callback.err - An error returned while making this request.
359-
* @param {module:compute/address} callback.addresses - Address objects from
359+
* @param {module:compute/address[]} callback.addresses - Address objects from
360360
* this region.
361-
* @param {?object} callback.nextQuery - If present, query with this object to
362-
* check for more results.
363361
* @param {object} callback.apiResponse - The full API response.
364362
*
365363
* @example
@@ -462,10 +460,8 @@ Region.prototype.getAddresses = function(options, callback) {
462460
* representing part of the larger set of results to view.
463461
* @param {function} callback - The callback function.
464462
* @param {?error} callback.err - An error returned while making this request.
465-
* @param {module:compute/operation} callback.operations - Operation objects
463+
* @param {module:compute/operation[]} callback.operations - Operation objects
466464
* from this region.
467-
* @param {?object} callback.nextQuery - If present, query with this object to
468-
* check for more results.
469465
* @param {object} callback.apiResponse - The full API response.
470466
*
471467
* @example
@@ -567,9 +563,8 @@ Region.prototype.getOperations = function(options, callback) {
567563
* representing part of the larger set of results to view.
568564
* @param {function} callback - The callback function.
569565
* @param {?error} callback.err - An error returned while making this request.
570-
* @param {module:compute/rule} callback.rules - Rule objects from this region.
571-
* @param {?object} callback.nextQuery - If present, query with this object to
572-
* check for more results.
566+
* @param {module:compute/rule[]} callback.rules - Rule objects from this
567+
* region.
573568
* @param {object} callback.apiResponse - The full API response.
574569
*
575570
* @example
@@ -674,8 +669,6 @@ Region.prototype.getRules = function(options, callback) {
674669
* @param {?error} callback.err - An error returned while making this request.
675670
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
676671
* objects from this region.
677-
* @param {?object} callback.nextQuery - If present, query with this object to
678-
* check for more results.
679672
* @param {object} callback.apiResponse - The full API response.
680673
*
681674
* @example

‎packages/google-cloud-compute/src/zone.js

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -690,8 +690,6 @@ Zone.prototype.disk = function(name) {
690690
* @param {?error} callback.err - An error returned while making this request.
691691
* @param {module:compute/autoscaler[]} callback.autoscalers - Autoscaler
692692
* objects from your project.
693-
* @param {?object} callback.nextQuery - If present, query with this object to
694-
* check for more results.
695693
* @param {object} callback.apiResponse - The full API response.
696694
*
697695
* @example
@@ -795,9 +793,7 @@ Zone.prototype.getAutoscalers = function(options, callback) {
795793
* representing part of the larger set of results to view.
796794
* @param {function} callback - The callback function.
797795
* @param {?error} callback.err - An error returned while making this request.
798-
* @param {module:compute/disk} callback.disks - Disk objects from this zone.
799-
* @param {?object} callback.nextQuery - If present, query with this object to
800-
* check for more results.
796+
* @param {module:compute/disk[]} callback.disks - Disk objects from this zone.
801797
* @param {object} callback.apiResponse - The full API response.
802798
*
803799
* @example
@@ -903,8 +899,6 @@ Zone.prototype.getDisks = function(options, callback) {
903899
* @param {?error} callback.err - An error returned while making this request.
904900
* @param {module:compute/instance-group[]} callback.instanceGroups -
905901
* InstanceGroup objects from this zone.
906-
* @param {?object} callback.nextQuery - If present, query with this object to
907-
* check for more results.
908902
* @param {object} callback.apiResponse - The full API response.
909903
*
910904
* @example
@@ -1004,8 +998,6 @@ Zone.prototype.getInstanceGroups = function(options, callback) {
1004998
* @param {?error} callback.err - An error returned while making this request.
1005999
* @param {module:compute/machine-type[]} callback.machineTypes - MachineType
10061000
* objects from this zone.
1007-
* @param {?object} callback.nextQuery - If present, query with this object to
1008-
* check for more results.
10091001
* @param {object} callback.apiResponse - The full API response.
10101002
*
10111003
* @example
@@ -1084,10 +1076,8 @@ Zone.prototype.getMachineTypes = function(options, callback) {
10841076
* representing part of the larger set of results to view.
10851077
* @param {function} callback - The callback function.
10861078
* @param {?error} callback.err - An error returned while making this request.
1087-
* @param {module:compute/operation} callback.operations - Operation objects
1079+
* @param {module:compute/operation[]} callback.operations - Operation objects
10881080
* from this zone.
1089-
* @param {?object} callback.nextQuery - If present, query with this object to
1090-
* check for more results.
10911081
* @param {object} callback.apiResponse - The full API response.
10921082
*
10931083
* @example
@@ -1188,9 +1178,7 @@ Zone.prototype.getOperations = function(options, callback) {
11881178
* representing part of the larger set of results to view.
11891179
* @param {function} callback - The callback function.
11901180
* @param {?error} callback.err - An error returned while making this request.
1191-
* @param {module:compute/vm} callback.vms - VM objects from this zone.
1192-
* @param {?object} callback.nextQuery - If present, query with this object to
1193-
* check for more results.
1181+
* @param {module:compute/vm[]} callback.vms - VM objects from this zone.
11941182
* @param {object} callback.apiResponse - The full API response.
11951183
*
11961184
* @example

0 commit comments

Comments
 (0)