Skip to content

Commit

Permalink
Fixed documentation to pass jslint rules
Browse files Browse the repository at this point in the history
  • Loading branch information
authtestprod committed Jul 15, 2016
1 parent 791ea5c commit f992360
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 12 deletions.
4 changes: 2 additions & 2 deletions lib/compute/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -1184,8 +1184,8 @@ Compute.prototype.getFirewalls = function(options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/firewall} callback.subnetworks - Subnetwork objects from
* your project.
* @param {module:compute/firewall} callback.subnetworks - Subnetwork objects
* from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
Expand Down
10 changes: 6 additions & 4 deletions lib/compute/network.js
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,8 @@ Network.prototype.createFirewall = function(name, config, callback) {
* are owned by this subnetwork. Provide this property when you create the
* subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be
* unique and non-overlapping within a network.
* @param {string} config.region - URL of the region where the Subnetwork resides.
* @param {string} config.region - URL of the region where the Subnetwork
* resides.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/rule} callback.rule - The created Rule object.
Expand All @@ -251,7 +252,8 @@ Network.prototype.createFirewall = function(name, config, callback) {
* ipCidrRange: '10.0.1.0/24'
* };
*
* network.createSubnetwork(name, config, function (err, subnetwork, operation, apiResponse) {
* network.createSubnetwork(name, config,
* function (err, subnetwork, operation, apiResponse) {
* // `subnetwork` is a Subnetwork object.
*
* // `operation` is an Operation object that can be used to check the status
Expand Down Expand Up @@ -290,8 +292,8 @@ Network.prototype.createSubnetwork = function(name, config, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/firewall} callback.subnetworks - Subnetwork objects from
* your project.
* @param {module:compute/firewall} callback.subnetworks - Subnetwork objects
* from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
Expand Down
13 changes: 8 additions & 5 deletions lib/compute/region.js
Original file line number Diff line number Diff line change
Expand Up @@ -242,8 +242,8 @@ Region.prototype.createAddress = function(name, options, callback) {
* representing part of the larger set of results to view.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/firewall} callback.subnetworks - Subnetwork objects from
* your project.
* @param {module:compute/firewall} callback.subnetworks - Subnetwork objects
* from your project.
* @param {?object} callback.nextQuery - If present, query with this object to
* check for more results.
* @param {object} callback.apiResponse - The full API response.
Expand Down Expand Up @@ -334,8 +334,10 @@ Region.prototype.subnetwork = function(name) {
* unique and non-overlapping within a network.
* @param {string} config.network - The URL of the network to which this
* subnetwork belongs, provided by the client when initially creating
* the subnetwork. Only networks that are in the distributed mode can have subnetworks.
* @param {string=} config.region - URL of the region where the Subnetwork resides.
* the subnetwork. Only networks that are in the distributed mode can have
* subnetworks.
* @param {string=} config.region - URL of the region where the Subnetwork
* resides.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request.
* @param {module:compute/rule} callback.rule - The created Rule object.
Expand All @@ -351,7 +353,8 @@ Region.prototype.subnetwork = function(name) {
* ipCidrRange: '10.0.1.0/24'
* };
*
* region.createSubnetwork(name, config, function (err, subnetwork, operation, apiResponse) {
* region.createSubnetwork(name, config,
* function (err, subnetwork, operation, apiResponse) {
* // `subnetwork` is a Subnetwork object.
*
* // `operation` is an Operation object that can be used to check the status
Expand Down
3 changes: 2 additions & 1 deletion lib/compute/subnetwork.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ function Subnetwork(region, name) {
* // ...
* };
*
* subnetwork.create(config, function(err, subnetwork, operation, apiResponse) {
* subnetwork.create(config,
* function(err, subnetwork, operation, apiResponse) {
* // `subnetwork` is a Subnetwork object.
*
* // `operation` is an Operation object that can be used to check the
Expand Down

0 comments on commit f992360

Please sign in to comment.