Fix DataStore cleanup docs (#1911)

* fix RoleStore Docs

* fix ChannelStore docs

* fix GuildChannelStore docs

* fix GuildStore docs

* fix MessageStore docs

* fix ReactionStore docs
This commit is contained in:
bdistin
2017-09-08 17:16:43 -05:00
committed by Crawl
parent 67c239b33f
commit 4748577194
6 changed files with 30 additions and 18 deletions

View File

@@ -84,6 +84,7 @@ class ChannelStore extends DataStore {
* Resolves a ChannelResolvable to a Channel object.
* @method resolve
* @memberof ChannelStore
* @instance
* @param {ChannelResolvable} channel The channel resolvable to resolve
* @returns {?Channel}
*/
@@ -92,6 +93,7 @@ class ChannelStore extends DataStore {
* Resolves a ChannelResolvable to a channel ID string.
* @method resolveID
* @memberof ChannelStore
* @instance
* @param {ChannelResolvable} channel The channel resolvable to resolve
* @returns {?string}
*/

View File

@@ -31,6 +31,7 @@ class GuildChannelStore extends DataStore {
* Resolves a GuildChannelResolvable to a Channel object.
* @method resolve
* @memberof GuildChannelStore
* @instance
* @param {GuildChannelResolvable} channel The GuildChannel resolvable to resolve
* @returns {?Channel}
*/
@@ -39,6 +40,7 @@ class GuildChannelStore extends DataStore {
* Resolves a GuildChannelResolvable to a channel ID string.
* @method resolveID
* @memberof GuildChannelStore
* @instance
* @param {GuildChannelResolvable} channel The GuildChannel resolvable to resolve
* @returns {?string}
*/

View File

@@ -22,6 +22,7 @@ class GuildStore extends DataStore {
* Resolves a GuildResolvable to a Guild object.
* @method resolve
* @memberof GuildStore
* @instance
* @param {GuildResolvable} guild The guild resolvable to identify
* @returns {?Guild}
*/
@@ -30,6 +31,7 @@ class GuildStore extends DataStore {
* Resolves a GuildResolvable to a Guild ID string.
* @method resolveID
* @memberof GuildStore
* @instance
* @param {GuildResolvable} guild The guild resolvable to identify
* @returns {?string}
*/

View File

@@ -98,17 +98,19 @@ class MessageStore extends DataStore {
*/
/**
* Resolves a MessageResolvable to a Message object.
* @method resolve
* @memberof MessageStore
* Resolves a MessageResolvable to a Message object.
* @method resolve
* @memberof MessageStore
* @instance
* @param {MessageResolvable} message The message resolvable to resolve
* @returns {?Message}
*/
/**
* Resolves a MessageResolvable to a Message ID string.
* @method MessageStore
* @memberof PresenceStore
* Resolves a MessageResolvable to a Message ID string.
* @method MessageStore
* @memberof PresenceStore
* @instance
* @param {MessageResolvable} message The message resolvable to resolve
* @returns {?string}
*/

View File

@@ -25,17 +25,19 @@ class ReactionStore extends DataStore {
*/
/**
* Resolves a MessageReactionResolvable to a MessageReaction object.
* @method resolve
* @memberof ReactionStore
* Resolves a MessageReactionResolvable to a MessageReaction object.
* @method resolve
* @memberof ReactionStore
* @instance
* @param {MessageReactionResolvable} reaction The MessageReaction to resolve
* @returns {?MessageReaction}
*/
/**
* Resolves a MessageReactionResolvable to a MessageReaction ID string.
* @method resolveID
* @memberof ReactionStore
* Resolves a MessageReactionResolvable to a MessageReaction ID string.
* @method resolveID
* @memberof ReactionStore
* @instance
* @param {MessageReactionResolvable} role The role resolvable to resolve
* @returns {?string}
*/

View File

@@ -24,17 +24,19 @@ class RoleStore extends DataStore {
*/
/**
* Resolves a RoleResolvable to a Role object.
* @method resolve
* @memberof RoleStore
* Resolves a RoleResolvable to a Role object.
* @method resolve
* @memberof RoleStore
* @instance
* @param {RoleResolvable} role The role resolvable to resolve
* @returns {?Role}
*/
/**
* Resolves a RoleResolvable to a role ID string.
* @method resolveID
* @memberof RoleStore
* Resolves a RoleResolvable to a role ID string.
* @method resolveID
* @memberof RoleStore
* @instance
* @param {RoleResolvable} role The role resolvable to resolve
* @returns {?string}
*/