From bca4b038a59224529b683942de8b95b22dcfb8cb Mon Sep 17 00:00:00 2001 From: SpaceEEC Date: Sat, 7 Mar 2020 06:00:48 +0100 Subject: [PATCH] docs(BitField): document constructors of deriving classes (#3903) --- src/util/ActivityFlags.js | 7 +++++++ src/util/BitField.js | 4 ++-- src/util/Intents.js | 7 +++++++ src/util/MessageFlags.js | 7 +++++++ src/util/Permissions.js | 7 +++++++ src/util/Speaking.js | 7 +++++++ src/util/SystemChannelFlags.js | 7 +++++++ 7 files changed, 44 insertions(+), 2 deletions(-) diff --git a/src/util/ActivityFlags.js b/src/util/ActivityFlags.js index f6f5aac9e..40c9e7e16 100644 --- a/src/util/ActivityFlags.js +++ b/src/util/ActivityFlags.js @@ -8,6 +8,13 @@ const BitField = require('./BitField'); */ class ActivityFlags extends BitField {} +/** + * @name ActivityFlags + * @kind constructor + * @memberof ActivityFlags + * @param {BitFieldResolvable} [bits=0] Bit(s) to read from + */ + /** * Numeric activity flags. All available properties: * * `INSTANCE` diff --git a/src/util/BitField.js b/src/util/BitField.js index 8de151d01..ec1f8dc09 100644 --- a/src/util/BitField.js +++ b/src/util/BitField.js @@ -7,7 +7,7 @@ const { RangeError } = require('../errors'); */ class BitField { /** - * @param {BitFieldResolvable} [bits=0] Bits(s) to read from + * @param {BitFieldResolvable} [bits=0] Bit(s) to read from */ constructor(bits) { /** @@ -48,7 +48,7 @@ class BitField { /** * Gets all given bits that are missing from the bitfield. - * @param {BitFieldResolvable} bits Bits(s) to check for + * @param {BitFieldResolvable} bits Bit(s) to check for * @param {...*} hasParams Additional parameters for the has method, if any * @returns {string[]} */ diff --git a/src/util/Intents.js b/src/util/Intents.js index 06ef470b9..dc85e55b8 100644 --- a/src/util/Intents.js +++ b/src/util/Intents.js @@ -7,6 +7,13 @@ const BitField = require('./BitField'); */ class Intents extends BitField {} +/** + * @name Intents + * @kind constructor + * @memberof Intents + * @param {IntentsResolvable} [bits=0] Bit(s) to read from + */ + /** * Data that can be resolved to give a permission number. This can be: * * A string (see {@link Intents.FLAGS}) diff --git a/src/util/MessageFlags.js b/src/util/MessageFlags.js index 4863e6710..f2bccc9a8 100644 --- a/src/util/MessageFlags.js +++ b/src/util/MessageFlags.js @@ -8,6 +8,13 @@ const BitField = require('./BitField'); */ class MessageFlags extends BitField {} +/** + * @name MessageFlags + * @kind constructor + * @memberof MessageFlags + * @param {BitFieldResolvable} [bits=0] Bit(s) to read from + */ + /** * Numeric message flags. All available properties: * * `CROSSPOSTED` diff --git a/src/util/Permissions.js b/src/util/Permissions.js index 831f17386..1d6aba30e 100644 --- a/src/util/Permissions.js +++ b/src/util/Permissions.js @@ -9,6 +9,13 @@ const BitField = require('./BitField'); * @extends {BitField} */ class Permissions extends BitField { + /** + * @name Permissions + * @kind constructor + * @memberof Permissions + * @param {PermissionResolvable} [bits=0] Bit(s) to read from + */ + /** * Data that can be resolved to give a permission number. This can be: * * A string (see {@link Permissions.FLAGS}) diff --git a/src/util/Speaking.js b/src/util/Speaking.js index 18c1ae6a4..8f819d1d4 100644 --- a/src/util/Speaking.js +++ b/src/util/Speaking.js @@ -9,6 +9,13 @@ const BitField = require('./BitField'); */ class Speaking extends BitField {} +/** + * @name Speaking + * @kind constructor + * @memberof Speaking + * @param {BitFieldResolvable} [bits=0] Bit(s) to read from + */ + /** * Numeric speaking flags. All available properties: * * `SPEAKING` diff --git a/src/util/SystemChannelFlags.js b/src/util/SystemChannelFlags.js index be953f71d..4d08b7609 100644 --- a/src/util/SystemChannelFlags.js +++ b/src/util/SystemChannelFlags.js @@ -10,6 +10,13 @@ const BitField = require('./BitField'); */ class SystemChannelFlags extends BitField {} +/** + * @name SystemChannelFlags + * @kind constructor + * @memberof SystemChannelFlags + * @param {SystemChannelFlagsResolvable} [bits=0] Bit(s) to read from + */ + /** * Data that can be resolved to give a sytem channel flag bitfield. This can be: * * A string (see {@link SystemChannelFlags.FLAGS})