Docs cleanup

2026-03-12 01:23:31 +01:00 · 2017-08-20 22:08:37 +02:00
parent c33b78da23
commit c7d1507e19
32 changed files with 287 additions and 267 deletions
--- a/src/util/Constants.js
+++ b/src/util/Constants.js
@@ -220,12 +220,12 @@ const Endpoints = exports.Endpoints = {

 /**
 * The current status of the client. Here are the available statuses:
- * - READY
- * - CONNECTING
- * - RECONNECTING
- * - IDLE
- * - NEARLY
- * - DISCONNECTED
+ * * READY
+ * * CONNECTING
+ * * RECONNECTING
+ * * IDLE
+ * * NEARLY
+ * * DISCONNECTED
 * @typedef {number} Status
 */
 exports.Status = {
@@ -239,11 +239,11 @@ exports.Status = {

 /**
 * The current status of a voice connection. Here are the available statuses:
- * - CONNECTED
- * - CONNECTING
- * - AUTHENTICATING
- * - RECONNECTING
- * - DISCONNECTED
+ * * CONNECTED
+ * * CONNECTING
+ * * AUTHENTICATING
+ * * RECONNECTING
+ * * DISCONNECTED
 * @typedef {number} VoiceStatus
 */
 exports.VoiceStatus = {
@@ -333,41 +333,41 @@ exports.Events = {

 /**
 * The type of a websocket message event, e.g. `MESSAGE_CREATE`. Here are the available events:
- * - READY
- * - RESUMED
- * - GUILD_SYNC
- * - GUILD_CREATE
- * - GUILD_DELETE
- * - GUILD_UPDATE
- * - GUILD_MEMBER_ADD
- * - GUILD_MEMBER_REMOVE
- * - GUILD_MEMBER_UPDATE
- * - GUILD_MEMBERS_CHUNK
- * - GUILD_ROLE_CREATE
- * - GUILD_ROLE_DELETE
- * - GUILD_ROLE_UPDATE
- * - GUILD_BAN_ADD
- * - GUILD_BAN_REMOVE
- * - CHANNEL_CREATE
- * - CHANNEL_DELETE
- * - CHANNEL_UPDATE
- * - CHANNEL_PINS_UPDATE
- * - MESSAGE_CREATE
- * - MESSAGE_DELETE
- * - MESSAGE_UPDATE
- * - MESSAGE_DELETE_BULK
- * - MESSAGE_REACTION_ADD
- * - MESSAGE_REACTION_REMOVE
- * - MESSAGE_REACTION_REMOVE_ALL
- * - USER_UPDATE
- * - USER_NOTE_UPDATE
- * - USER_SETTINGS_UPDATE
- * - PRESENCE_UPDATE
- * - VOICE_STATE_UPDATE
- * - TYPING_START
- * - VOICE_SERVER_UPDATE
- * - RELATIONSHIP_ADD
- * - RELATIONSHIP_REMOVE
+ * * READY
+ * * RESUMED
+ * * GUILD_SYNC
+ * * GUILD_CREATE
+ * * GUILD_DELETE
+ * * GUILD_UPDATE
+ * * GUILD_MEMBER_ADD
+ * * GUILD_MEMBER_REMOVE
+ * * GUILD_MEMBER_UPDATE
+ * * GUILD_MEMBERS_CHUNK
+ * * GUILD_ROLE_CREATE
+ * * GUILD_ROLE_DELETE
+ * * GUILD_ROLE_UPDATE
+ * * GUILD_BAN_ADD
+ * * GUILD_BAN_REMOVE
+ * * CHANNEL_CREATE
+ * * CHANNEL_DELETE
+ * * CHANNEL_UPDATE
+ * * CHANNEL_PINS_UPDATE
+ * * MESSAGE_CREATE
+ * * MESSAGE_DELETE
+ * * MESSAGE_UPDATE
+ * * MESSAGE_DELETE_BULK
+ * * MESSAGE_REACTION_ADD
+ * * MESSAGE_REACTION_REMOVE
+ * * MESSAGE_REACTION_REMOVE_ALL
+ * * USER_UPDATE
+ * * USER_NOTE_UPDATE
+ * * USER_SETTINGS_UPDATE
+ * * PRESENCE_UPDATE
+ * * VOICE_STATE_UPDATE
+ * * TYPING_START
+ * * VOICE_SERVER_UPDATE
+ * * RELATIONSHIP_ADD
+ * * RELATIONSHIP_REMOVE
 * @typedef {string} WSEventType
 */
 exports.WSEvents = {
@@ -409,6 +409,18 @@ exports.WSEvents = {
  RELATIONSHIP_REMOVE: 'RELATIONSHIP_REMOVE',
 };

+/**
+ * The type of a message, e.g. `DEFAULT`. Here are the available types:
+ * * DEFAULT
+ * * RECIPIENT_ADD
+ * * RECIPIENT_REMOVE
+ * * CALL
+ * * CHANNEL_NAME_CHANGE
+ * * CHANNEL_ICON_CHANGE
+ * * PINS_ADD
+ * * GUILD_MEMBER_JOIN
+ * @typedef {string} MessageType
+ */
 exports.MessageTypes = [
  'DEFAULT',
  'RECIPIENT_ADD',
@@ -597,49 +609,49 @@ exports.Colors = {

 /**
 * An error encountered while performing an API request. Here are the potential errors:
- * - UNKNOWN_ACCOUNT
- * - UNKNOWN_APPLICATION
- * - UNKNOWN_CHANNEL
- * - UNKNOWN_GUILD
- * - UNKNOWN_INTEGRATION
- * - UNKNOWN_INVITE
- * - UNKNOWN_MEMBER
- * - UNKNOWN_MESSAGE
- * - UNKNOWN_OVERWRITE
- * - UNKNOWN_PROVIDER
- * - UNKNOWN_ROLE
- * - UNKNOWN_TOKEN
- * - UNKNOWN_USER
- * - UNKNOWN_EMOJI
- * - BOT_PROHIBITED_ENDPOINT
- * - BOT_ONLY_ENDPOINT
- * - MAXIMUM_GUILDS
- * - MAXIMUM_FRIENDS
- * - MAXIMUM_PINS
- * - MAXIMUM_ROLES
- * - MAXIMUM_REACTIONS
- * - UNAUTHORIZED
- * - MISSING_ACCESS
- * - INVALID_ACCOUNT_TYPE
- * - CANNOT_EXECUTE_ON_DM
- * - EMBED_DISABLED
- * - CANNOT_EDIT_MESSAGE_BY_OTHER
- * - CANNOT_SEND_EMPTY_MESSAGE
- * - CANNOT_MESSAGE_USER
- * - CANNOT_SEND_MESSAGES_IN_VOICE_CHANNEL
- * - CHANNEL_VERIFICATION_LEVEL_TOO_HIGH
- * - OAUTH2_APPLICATION_BOT_ABSENT
- * - MAXIMUM_OAUTH2_APPLICATIONS
- * - INVALID_OAUTH_STATE
- * - MISSING_PERMISSIONS
- * - INVALID_AUTHENTICATION_TOKEN
- * - NOTE_TOO_LONG
- * - INVALID_BULK_DELETE_QUANTITY
- * - CANNOT_PIN_MESSAGE_IN_OTHER_CHANNEL
- * - CANNOT_EXECUTE_ON_SYSTEM_MESSAGE
- * - BULK_DELETE_MESSAGE_TOO_OLD
- * - INVITE_ACCEPTED_TO_GUILD_NOT_CONTANING_BOT
- * - REACTION_BLOCKED
+ * * UNKNOWN_ACCOUNT
+ * * UNKNOWN_APPLICATION
+ * * UNKNOWN_CHANNEL
+ * * UNKNOWN_GUILD
+ * * UNKNOWN_INTEGRATION
+ * * UNKNOWN_INVITE
+ * * UNKNOWN_MEMBER
+ * * UNKNOWN_MESSAGE
+ * * UNKNOWN_OVERWRITE
+ * * UNKNOWN_PROVIDER
+ * * UNKNOWN_ROLE
+ * * UNKNOWN_TOKEN
+ * * UNKNOWN_USER
+ * * UNKNOWN_EMOJI
+ * * BOT_PROHIBITED_ENDPOINT
+ * * BOT_ONLY_ENDPOINT
+ * * MAXIMUM_GUILDS
+ * * MAXIMUM_FRIENDS
+ * * MAXIMUM_PINS
+ * * MAXIMUM_ROLES
+ * * MAXIMUM_REACTIONS
+ * * UNAUTHORIZED
+ * * MISSING_ACCESS
+ * * INVALID_ACCOUNT_TYPE
+ * * CANNOT_EXECUTE_ON_DM
+ * * EMBED_DISABLED
+ * * CANNOT_EDIT_MESSAGE_BY_OTHER
+ * * CANNOT_SEND_EMPTY_MESSAGE
+ * * CANNOT_MESSAGE_USER
+ * * CANNOT_SEND_MESSAGES_IN_VOICE_CHANNEL
+ * * CHANNEL_VERIFICATION_LEVEL_TOO_HIGH
+ * * OAUTH2_APPLICATION_BOT_ABSENT
+ * * MAXIMUM_OAUTH2_APPLICATIONS
+ * * INVALID_OAUTH_STATE
+ * * MISSING_PERMISSIONS
+ * * INVALID_AUTHENTICATION_TOKEN
+ * * NOTE_TOO_LONG
+ * * INVALID_BULK_DELETE_QUANTITY
+ * * CANNOT_PIN_MESSAGE_IN_OTHER_CHANNEL
+ * * CANNOT_EXECUTE_ON_SYSTEM_MESSAGE
+ * * BULK_DELETE_MESSAGE_TOO_OLD
+ * * INVITE_ACCEPTED_TO_GUILD_NOT_CONTANING_BOT
+ * * REACTION_BLOCKED
 * @typedef {string} APIError
 */
 exports.APIErrors = {
--- a/src/util/Permissions.js
+++ b/src/util/Permissions.js
@@ -103,7 +103,7 @@ class Permissions {
  }

  /**
-   * Gets an object mapping permission name (like `READ_MESSAGES`) to a {@link boolean} indicating whether the
+   * Gets an object mapping permission name (like `VIEW_CHANNEL`) to a {@link boolean} indicating whether the
   * permission is available.
   * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override
   * @returns {Object}
@@ -152,8 +152,8 @@ class Permissions {

  /**
   * Data that can be resolved to give a permission number. This can be:
-   * - A string (see {@link Permissions.FLAGS})
-   * - A permission number
+   * * A string (see {@link Permissions.FLAGS})
+   * * A permission number
   * @typedef {string|number} PermissionResolvable
   */

--- a/src/util/Util.js
+++ b/src/util/Util.js
@@ -66,9 +66,9 @@ class Util {

  /**
   * Parses emoji info out of a string. The string must be one of:
-   * - A UTF-8 emoji (no ID)
-   * - A URL-encoded UTF-8 emoji (no ID)
-   * - A Discord custom emoji (`<:name:id>`)
+   * * A UTF-8 emoji (no ID)
+   * * A URL-encoded UTF-8 emoji (no ID)
+   * * A Discord custom emoji (`<:name:id>`)
   * @param {string} text Emoji string to parse
   * @returns {Object} Object with `name` and `id` properties
   * @private