Skip to content

docs: fix storage jsdoc #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephenplusplus merged 1 commit into from
Dec 3, 2014
Merged

docs: fix storage jsdoc #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions lib/storage/acl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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',
Expand Down Expand Up @@ -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'
Expand All @@ -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',
Expand Down Expand Up @@ -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();
*
Expand All @@ -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',
Expand Down
10 changes: 5 additions & 5 deletions lib/storage/bucket.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 */
}

Expand Down