Skip to content

Commit

Permalink
Add callback documentation to some pubsub methods.
Browse files Browse the repository at this point in the history
  • Loading branch information
jgeewax authored and stephenplusplus committed Jun 8, 2015
1 parent 772f89e commit 01ec51f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions lib/pubsub/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,12 @@ function PubSub(options) {
* @param {string=} query.pageToken - Page token.
* @param {number=} query.pageSize - Max number of results to return.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error from the API call, may be null.
* @param {module:pubsub/topic[]} callback.topics - The list of topics returned.
* @param {object} callback.nextQuery - A query object representing the next
* page of topics.
* @param {object} callback.apiResponse - The full API response from the
* service.
*
* @example
* // Get all topics.
Expand Down Expand Up @@ -147,6 +153,10 @@ PubSub.prototype.getTopics = function(query, callback) {
*
* @param {string} name - Name of the topic.
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error from the API call, may be null.
* @param {module:pubsub/topic} callback.topic - The newly created topic.
* @param {object} callback.apiResponse - The full API response from the
* service.
*
* @example
* pubsub.createTopic('my-new-topic', function(err, topic, apiResponse) {
Expand Down Expand Up @@ -341,6 +351,13 @@ PubSub.prototype.topic = function(name, options) {
* @param {number} options.pageSize - Maximum number of results to return.
* @param {string} options.pageToken - Page token.
* @param {function} callback - The callback function.
* @param {?error} callback.err - An error from the API call, may be null.
* @param {module:pubsub/subscription[]} callback.subscriptions - The list of
* subscriptions returned.
* @param {object} callback.nextQuery - A query object representing the next
* page of topics.
* @param {object} callback.apiResponse - The full API response from the
* service.
*
* @example
* var callback = function(err, subscriptions, nextQuery, apiResponse) {
Expand Down

0 comments on commit 01ec51f

Please sign in to comment.