From 33b56211a667a8099baceb46a7ba13da21ea5d6f Mon Sep 17 00:00:00 2001 From: Stephen Sawchuk Date: Wed, 3 Dec 2014 17:10:50 -0500 Subject: [PATCH] docs: fix storage jsdoc --- lib/storage/acl.js | 14 +++++++++++--- lib/storage/bucket.js | 10 +++++----- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/lib/storage/acl.js b/lib/storage/acl.js index 87e46bcb941..679ec5a0085 100644 --- a/lib/storage/acl.js +++ b/lib/storage/acl.js @@ -58,6 +58,8 @@ function Acl(options) { * revision of this file (as opposed to the latest version, the default). * @param {function} callback - The callback function. * + * @alias acl.add + * * @example * myBucket.acl.add({ * scope: 'user-useremail@example.com', @@ -108,13 +110,15 @@ Acl.prototype.add = function(options, callback) { * revision of this file (as opposed to the latest version, the default). * @param {function} callback - The callback function. * + * @alias acl.delete + * * @example * myBucket.acl.delete({ * scope: 'user-useremail@example.com' * }, function(err) {}); * * //- - * // For file ACL operations, an options object is also accepted. + * // For file ACL operations, you can also specify a `generation` property. * //- * myFile.acl.delete({ * scope: 'user-useremail@example.com', @@ -146,6 +150,8 @@ Acl.prototype.delete = function(options, callback) { * @param {int=} options.generation - **File Objects Only** Select a specific * revision of this file (as opposed to the latest version, the default). * + * @alias acl.get + * * @example * myBucket.acl.get({ * scope: 'user-useremail@example.com' @@ -164,7 +170,7 @@ Acl.prototype.delete = function(options, callback) { * }); * * //- - * // For file ACL operations, an options object is also accepted. + * // For file ACL operations, you can also specify a `generation` property. * //- * myFile.acl.get({ * scope: 'user-useremail@example.com', @@ -218,6 +224,8 @@ Acl.prototype.get = function(options, callback) { * revision of this file (as opposed to the latest version, the default). * @param {function} callback - The callback function. * + * @alias acl.update + * * @example * var storage = gcloud.storage(); * @@ -227,7 +235,7 @@ Acl.prototype.get = function(options, callback) { * }, function(err) {}); * * //- - * // For file ACL operations, an options object is also accepted. + * // For file ACL operations, you can also specify a `generation` property. * //- * myFile.acl.update({ * scope: 'user-useremail@example.com', diff --git a/lib/storage/bucket.js b/lib/storage/bucket.js index 2bfd1b0907b..46cb833611d 100644 --- a/lib/storage/bucket.js +++ b/lib/storage/bucket.js @@ -146,31 +146,31 @@ function Bucket(storage, name) { * * @alias acl.default */ - var aclDefault; + var aclDefault = true; /** * Maps to {module:storage/bucket#acl.add}. * @alias acl.default.add */ - var aclDefaultAdd; + var aclDefaultAdd = true; /** * Maps to {module:storage/bucket#acl.delete}. * @alias acl.default.delete */ - var aclDefaultDelete; + var aclDefaultDelete = true; /** * Maps to {module:storage/bucket#acl.get}. * @alias acl.default.get */ - var aclDefaultGet; + var aclDefaultGet = true; /** * Maps to {module:storage/bucket#acl.update}. * @alias acl.default.update */ - var aclDefaultUpdate; + var aclDefaultUpdate = true; /* jshint ignore:end */ }