Skip to content

Commit 1ae2317

Browse files
weakishleeyeh
authored andcommitted
docs(status): detailed comment statusQuery(source) (#559)
* doc(status): detailed comment statusQuery(source) * docs(status): more accurate para type in comments * docs(status): typo in comment
1 parent 4e3f70f commit 1ae2317

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/status.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ module.exports = function(AV) {
235235
/**
236236
* Count unread statuses in someone's inbox.
237237
* @since 0.3.0
238-
* @param {Object} owner The status owner.
238+
* @param {AV.User} owner The status owner.
239239
* @param {String} inboxType The inbox type, 'default' by default.
240240
* @param {AuthOptions} options
241241
* @return {Promise} A promise that is fulfilled when the count
@@ -273,7 +273,7 @@ module.exports = function(AV) {
273273
/**
274274
* reset unread statuses count in someone's inbox.
275275
* @since 2.1.0
276-
* @param {Object} owner The status owner.
276+
* @param {AV.User} owner The status owner.
277277
* @param {String} inboxType The inbox type, 'default' by default.
278278
* @param {AuthOptions} options
279279
* @return {Promise} A promise that is fulfilled when the reset
@@ -311,7 +311,7 @@ module.exports = function(AV) {
311311
/**
312312
* Create a status query to find someone's published statuses.
313313
* @since 0.3.0
314-
* @param {Object} source The status source.
314+
* @param {AV.User} source The status source, typically the publisher.
315315
* @return {AV.Query} The query object for status.
316316
* @example
317317
* //Find current user's published statuses.
@@ -375,7 +375,7 @@ module.exports = function(AV) {
375375
},
376376
/**
377377
* Sets the owner of the querying inbox.
378-
* @param {Object} owner The inbox owner.
378+
* @param {AV.User} owner The inbox owner.
379379
* @return {AV.InboxQuery} Returns the query, so you can chain this call.
380380
*/
381381
owner: function(owner) {
@@ -384,7 +384,7 @@ module.exports = function(AV) {
384384
},
385385
/**
386386
* Sets the querying inbox type.default is 'default'.
387-
* @param {Object} owner The inbox type.
387+
* @param {Object} type The inbox type.
388388
* @return {AV.InboxQuery} Returns the query, so you can chain this call.
389389
*/
390390
inboxType: function(type) {
@@ -405,7 +405,7 @@ module.exports = function(AV) {
405405
/**
406406
* Create a inbox status query to find someone's inbox statuses.
407407
* @since 0.3.0
408-
* @param {Object} owner The inbox's owner
408+
* @param {AV.User} owner The inbox's owner
409409
* @param {String} inboxType The inbox type,'default' by default.
410410
* @return {AV.InboxQuery} The inbox query object.
411411
* @see AV.InboxQuery

0 commit comments

Comments
 (0)