Skip to content

Commit 4cd8813

Browse files
jkwluiJustinBeckwith
jkwlui
authored and
JustinBeckwith
committed
fix(docs): move jsdoc away from interface (googleapis#565)
* fix(docs): move jsdoc away from interface * fix bucket jsdoc comments * fix remaining files
1 parent 6501245 commit 4cd8813

7 files changed

Lines changed: 935 additions & 980 deletions

File tree

‎handwritten/storage/.jsdoc.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module.exports = {
3131
source: {
3232
excludePattern: '(^|\\/|\\\\)[._]',
3333
include: [
34-
'build'
34+
'build/src'
3535
],
3636
includePattern: '\\.js$'
3737
},

‎handwritten/storage/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"storage"
3131
],
3232
"scripts": {
33+
"predocs": "npm run compile",
3334
"docs": "jsdoc -c .jsdoc.js",
3435
"generate-scaffolding": "repo-tools generate all && repo-tools generate lib_samples_readme -l samples/ --config ../.cloud-repo-tools.json",
3536
"system-test": "mocha build/system-test --timeout 600000",

‎handwritten/storage/src/acl.ts‎

Lines changed: 151 additions & 146 deletions
Original file line numberDiff line numberDiff line change
@@ -112,159 +112,164 @@ class AclRoleAccessorMethods {
112112

113113
private static roles = ['OWNER', 'READER', 'WRITER'];
114114

115-
/**
116-
* An object of convenience methods to add or delete owner ACL permissions for
117-
* a given entity.
118-
*
119-
* The supported methods include:
120-
*
121-
* - `myFile.acl.owners.addAllAuthenticatedUsers`
122-
* - `myFile.acl.owners.deleteAllAuthenticatedUsers`
123-
* - `myFile.acl.owners.addAllUsers`
124-
* - `myFile.acl.owners.deleteAllUsers`
125-
* - `myFile.acl.owners.addDomain`
126-
* - `myFile.acl.owners.deleteDomain`
127-
* - `myFile.acl.owners.addGroup`
128-
* - `myFile.acl.owners.deleteGroup`
129-
* - `myFile.acl.owners.addProject`
130-
* - `myFile.acl.owners.deleteProject`
131-
* - `myFile.acl.owners.addUser`
132-
* - `myFile.acl.owners.deleteUser`
133-
*
134-
* @return {object}
135-
*
136-
* @example
137-
* const storage = require('@google-cloud/storage')();
138-
* const myBucket = storage.bucket('my-bucket');
139-
* const myFile = myBucket.file('my-file');
140-
*
141-
* //-
142-
* // Add a user as an owner of a file.
143-
* //-
144-
* const myBucket = gcs.bucket('my-bucket');
145-
* const myFile = myBucket.file('my-file');
146-
* myFile.acl.owners.addUser('email@example.com', function(err, aclObject)
147-
* {});
148-
*
149-
* //-
150-
* // For reference, the above command is the same as running the following.
151-
* //-
152-
* myFile.acl.add({
153-
* entity: 'user-email@example.com',
154-
* role: gcs.acl.OWNER_ROLE
155-
* }, function(err, aclObject) {});
156-
*
157-
* //-
158-
* // If the callback is omitted, we'll return a Promise.
159-
* //-
160-
* myFile.acl.owners.addUser('email@example.com').then(function(data) {
161-
* const aclObject = data[0];
162-
* const apiResponse = data[1];
163-
* });
164-
*/
165115
owners = {};
166116

167-
/**
168-
* An object of convenience methods to add or delete reader ACL permissions
169-
* for a given entity.
170-
*
171-
* The supported methods include:
172-
*
173-
* - `myFile.acl.readers.addAllAuthenticatedUsers`
174-
* - `myFile.acl.readers.deleteAllAuthenticatedUsers`
175-
* - `myFile.acl.readers.addAllUsers`
176-
* - `myFile.acl.readers.deleteAllUsers`
177-
* - `myFile.acl.readers.addDomain`
178-
* - `myFile.acl.readers.deleteDomain`
179-
* - `myFile.acl.readers.addGroup`
180-
* - `myFile.acl.readers.deleteGroup`
181-
* - `myFile.acl.readers.addProject`
182-
* - `myFile.acl.readers.deleteProject`
183-
* - `myFile.acl.readers.addUser`
184-
* - `myFile.acl.readers.deleteUser`
185-
*
186-
* @return {object}
187-
*
188-
* @example
189-
* const storage = require('@google-cloud/storage')();
190-
* const myBucket = storage.bucket('my-bucket');
191-
* const myFile = myBucket.file('my-file');
192-
*
193-
* //-
194-
* // Add a user as a reader of a file.
195-
* //-
196-
* myFile.acl.readers.addUser('email@example.com', function(err, aclObject)
197-
* {});
198-
*
199-
* //-
200-
* // For reference, the above command is the same as running the following.
201-
* //-
202-
* myFile.acl.add({
203-
* entity: 'user-email@example.com',
204-
* role: gcs.acl.READER_ROLE
205-
* }, function(err, aclObject) {});
206-
*
207-
* //-
208-
* // If the callback is omitted, we'll return a Promise.
209-
* //-
210-
* myFile.acl.readers.addUser('email@example.com').then(function(data) {
211-
* const aclObject = data[0];
212-
* const apiResponse = data[1];
213-
* });
214-
*/
215117
readers = {};
216118

217-
/**
218-
* An object of convenience methods to add or delete writer ACL permissions
219-
* for a given entity.
220-
*
221-
* The supported methods include:
222-
*
223-
* - `myFile.acl.writers.addAllAuthenticatedUsers`
224-
* - `myFile.acl.writers.deleteAllAuthenticatedUsers`
225-
* - `myFile.acl.writers.addAllUsers`
226-
* - `myFile.acl.writers.deleteAllUsers`
227-
* - `myFile.acl.writers.addDomain`
228-
* - `myFile.acl.writers.deleteDomain`
229-
* - `myFile.acl.writers.addGroup`
230-
* - `myFile.acl.writers.deleteGroup`
231-
* - `myFile.acl.writers.addProject`
232-
* - `myFile.acl.writers.deleteProject`
233-
* - `myFile.acl.writers.addUser`
234-
* - `myFile.acl.writers.deleteUser`
235-
*
236-
* @return {object}
237-
*
238-
* @example
239-
* const storage = require('@google-cloud/storage')();
240-
* const myBucket = storage.bucket('my-bucket');
241-
* const myFile = myBucket.file('my-file');
242-
*
243-
* //-
244-
* // Add a user as a writer of a file.
245-
* //-
246-
* myFile.acl.writers.addUser('email@example.com', function(err, aclObject)
247-
* {});
248-
*
249-
* //-
250-
* // For reference, the above command is the same as running the following.
251-
* //-
252-
* myFile.acl.add({
253-
* entity: 'user-email@example.com',
254-
* role: gcs.acl.WRITER_ROLE
255-
* }, function(err, aclObject) {});
256-
*
257-
* //-
258-
* // If the callback is omitted, we'll return a Promise.
259-
* //-
260-
* myFile.acl.writers.addUser('email@example.com').then(function(data) {
261-
* const aclObject = data[0];
262-
* const apiResponse = data[1];
263-
* });
264-
*/
265119
writers = {};
266120

267121
constructor() {
122+
/**
123+
* An object of convenience methods to add or delete owner ACL permissions
124+
* for a given entity.
125+
*
126+
* The supported methods include:
127+
*
128+
* - `myFile.acl.owners.addAllAuthenticatedUsers`
129+
* - `myFile.acl.owners.deleteAllAuthenticatedUsers`
130+
* - `myFile.acl.owners.addAllUsers`
131+
* - `myFile.acl.owners.deleteAllUsers`
132+
* - `myFile.acl.owners.addDomain`
133+
* - `myFile.acl.owners.deleteDomain`
134+
* - `myFile.acl.owners.addGroup`
135+
* - `myFile.acl.owners.deleteGroup`
136+
* - `myFile.acl.owners.addProject`
137+
* - `myFile.acl.owners.deleteProject`
138+
* - `myFile.acl.owners.addUser`
139+
* - `myFile.acl.owners.deleteUser`
140+
*
141+
* @name Acl#owners
142+
*
143+
* @example
144+
* const storage = require('@google-cloud/storage')();
145+
* const myBucket = storage.bucket('my-bucket');
146+
* const myFile = myBucket.file('my-file');
147+
*
148+
* //-
149+
* // Add a user as an owner of a file.
150+
* //-
151+
* const myBucket = gcs.bucket('my-bucket');
152+
* const myFile = myBucket.file('my-file');
153+
* myFile.acl.owners.addUser('email@example.com', function(err, aclObject)
154+
* {});
155+
*
156+
* //-
157+
* // For reference, the above command is the same as running the following.
158+
* //-
159+
* myFile.acl.add({
160+
* entity: 'user-email@example.com',
161+
* role: gcs.acl.OWNER_ROLE
162+
* }, function(err, aclObject) {});
163+
*
164+
* //-
165+
* // If the callback is omitted, we'll return a Promise.
166+
* //-
167+
* myFile.acl.owners.addUser('email@example.com').then(function(data) {
168+
* const aclObject = data[0];
169+
* const apiResponse = data[1];
170+
* });
171+
*/
172+
this.owners = {};
173+
174+
/**
175+
* An object of convenience methods to add or delete reader ACL permissions
176+
* for a given entity.
177+
*
178+
* The supported methods include:
179+
*
180+
* - `myFile.acl.readers.addAllAuthenticatedUsers`
181+
* - `myFile.acl.readers.deleteAllAuthenticatedUsers`
182+
* - `myFile.acl.readers.addAllUsers`
183+
* - `myFile.acl.readers.deleteAllUsers`
184+
* - `myFile.acl.readers.addDomain`
185+
* - `myFile.acl.readers.deleteDomain`
186+
* - `myFile.acl.readers.addGroup`
187+
* - `myFile.acl.readers.deleteGroup`
188+
* - `myFile.acl.readers.addProject`
189+
* - `myFile.acl.readers.deleteProject`
190+
* - `myFile.acl.readers.addUser`
191+
* - `myFile.acl.readers.deleteUser`
192+
*
193+
* @name Acl#readers
194+
*
195+
* @example
196+
* const storage = require('@google-cloud/storage')();
197+
* const myBucket = storage.bucket('my-bucket');
198+
* const myFile = myBucket.file('my-file');
199+
*
200+
* //-
201+
* // Add a user as a reader of a file.
202+
* //-
203+
* myFile.acl.readers.addUser('email@example.com', function(err, aclObject)
204+
* {});
205+
*
206+
* //-
207+
* // For reference, the above command is the same as running the following.
208+
* //-
209+
* myFile.acl.add({
210+
* entity: 'user-email@example.com',
211+
* role: gcs.acl.READER_ROLE
212+
* }, function(err, aclObject) {});
213+
*
214+
* //-
215+
* // If the callback is omitted, we'll return a Promise.
216+
* //-
217+
* myFile.acl.readers.addUser('email@example.com').then(function(data) {
218+
* const aclObject = data[0];
219+
* const apiResponse = data[1];
220+
* });
221+
*/
222+
this.readers = {};
223+
224+
/**
225+
* An object of convenience methods to add or delete writer ACL permissions
226+
* for a given entity.
227+
*
228+
* The supported methods include:
229+
*
230+
* - `myFile.acl.writers.addAllAuthenticatedUsers`
231+
* - `myFile.acl.writers.deleteAllAuthenticatedUsers`
232+
* - `myFile.acl.writers.addAllUsers`
233+
* - `myFile.acl.writers.deleteAllUsers`
234+
* - `myFile.acl.writers.addDomain`
235+
* - `myFile.acl.writers.deleteDomain`
236+
* - `myFile.acl.writers.addGroup`
237+
* - `myFile.acl.writers.deleteGroup`
238+
* - `myFile.acl.writers.addProject`
239+
* - `myFile.acl.writers.deleteProject`
240+
* - `myFile.acl.writers.addUser`
241+
* - `myFile.acl.writers.deleteUser`
242+
*
243+
* @name Acl#writers
244+
*
245+
* @example
246+
* const storage = require('@google-cloud/storage')();
247+
* const myBucket = storage.bucket('my-bucket');
248+
* const myFile = myBucket.file('my-file');
249+
*
250+
* //-
251+
* // Add a user as a writer of a file.
252+
* //-
253+
* myFile.acl.writers.addUser('email@example.com', function(err, aclObject)
254+
* {});
255+
*
256+
* //-
257+
* // For reference, the above command is the same as running the following.
258+
* //-
259+
* myFile.acl.add({
260+
* entity: 'user-email@example.com',
261+
* role: gcs.acl.WRITER_ROLE
262+
* }, function(err, aclObject) {});
263+
*
264+
* //-
265+
* // If the callback is omitted, we'll return a Promise.
266+
* //-
267+
* myFile.acl.writers.addUser('email@example.com').then(function(data) {
268+
* const aclObject = data[0];
269+
* const apiResponse = data[1];
270+
* });
271+
*/
272+
this.writers = {};
268273
AclRoleAccessorMethods.roles.forEach(this._assignAccessMethods.bind(this));
269274
}
270275

0 commit comments

Comments
 (0)
⚡