Skip to content

Commit d36802f

Browse files
Merge pull request #317 from stephenplusplus/spp--storage-docs-fixes
docs: fix storage jsdoc
2 parents b079bf5 + 33b5621 commit d36802f

2 files changed

Lines changed: 16 additions & 8 deletions

File tree

lib/storage/acl.js

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ function Acl(options) {
5858
* revision of this file (as opposed to the latest version, the default).
5959
* @param {function} callback - The callback function.
6060
*
61+
* @alias acl.add
62+
*
6163
* @example
6264
* myBucket.acl.add({
6365
* scope: 'user-useremail@example.com',
@@ -108,13 +110,15 @@ Acl.prototype.add = function(options, callback) {
108110
* revision of this file (as opposed to the latest version, the default).
109111
* @param {function} callback - The callback function.
110112
*
113+
* @alias acl.delete
114+
*
111115
* @example
112116
* myBucket.acl.delete({
113117
* scope: 'user-useremail@example.com'
114118
* }, function(err) {});
115119
*
116120
* //-
117-
* // For file ACL operations, an options object is also accepted.
121+
* // For file ACL operations, you can also specify a `generation` property.
118122
* //-
119123
* myFile.acl.delete({
120124
* scope: 'user-useremail@example.com',
@@ -146,6 +150,8 @@ Acl.prototype.delete = function(options, callback) {
146150
* @param {int=} options.generation - **File Objects Only** Select a specific
147151
* revision of this file (as opposed to the latest version, the default).
148152
*
153+
* @alias acl.get
154+
*
149155
* @example
150156
* myBucket.acl.get({
151157
* scope: 'user-useremail@example.com'
@@ -164,7 +170,7 @@ Acl.prototype.delete = function(options, callback) {
164170
* });
165171
*
166172
* //-
167-
* // For file ACL operations, an options object is also accepted.
173+
* // For file ACL operations, you can also specify a `generation` property.
168174
* //-
169175
* myFile.acl.get({
170176
* scope: 'user-useremail@example.com',
@@ -218,6 +224,8 @@ Acl.prototype.get = function(options, callback) {
218224
* revision of this file (as opposed to the latest version, the default).
219225
* @param {function} callback - The callback function.
220226
*
227+
* @alias acl.update
228+
*
221229
* @example
222230
* var storage = gcloud.storage();
223231
*
@@ -227,7 +235,7 @@ Acl.prototype.get = function(options, callback) {
227235
* }, function(err) {});
228236
*
229237
* //-
230-
* // For file ACL operations, an options object is also accepted.
238+
* // For file ACL operations, you can also specify a `generation` property.
231239
* //-
232240
* myFile.acl.update({
233241
* scope: 'user-useremail@example.com',

lib/storage/bucket.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,31 +146,31 @@ function Bucket(storage, name) {
146146
*
147147
* @alias acl.default
148148
*/
149-
var aclDefault;
149+
var aclDefault = true;
150150

151151
/**
152152
* Maps to {module:storage/bucket#acl.add}.
153153
* @alias acl.default.add
154154
*/
155-
var aclDefaultAdd;
155+
var aclDefaultAdd = true;
156156

157157
/**
158158
* Maps to {module:storage/bucket#acl.delete}.
159159
* @alias acl.default.delete
160160
*/
161-
var aclDefaultDelete;
161+
var aclDefaultDelete = true;
162162

163163
/**
164164
* Maps to {module:storage/bucket#acl.get}.
165165
* @alias acl.default.get
166166
*/
167-
var aclDefaultGet;
167+
var aclDefaultGet = true;
168168

169169
/**
170170
* Maps to {module:storage/bucket#acl.update}.
171171
* @alias acl.default.update
172172
*/
173-
var aclDefaultUpdate;
173+
var aclDefaultUpdate = true;
174174
/* jshint ignore:end */
175175
}
176176

0 commit comments

Comments
 (0)