docs: Update structure and access modifiers

Included some modules into a namespace and made some functions and enums private

src/core/discordBot.js

@@ -1,8 +1,4 @@
 /* eslint-disable jsdoc/require-example */
-/**
- * @file
- * @ignore
- */
 
 const { BotCommandDeployment } = require("../entities/command");
 const {
@@ -102,6 +98,7 @@ class DiscordBot {
     /**
      * Subscribe to the core events.
      * @returns {undefined}
+     * @private
      */
     listenToEvents() {
         this.client.on(Events.ClientReady, () => ready(this));

src/core/logger.js

@@ -1,10 +1,6 @@
-/**
- * @file
- * @ignore
- */
-
 /**
  * @module Logger
+ * @private
  */
 
 const { table } = require("table");
@@ -79,14 +75,15 @@ function logRecords(records, state) {
  * @property {Modules} type The module type.
  * @property {BotCommandDeployment} deployment The servers deployed to.
  * @interface
- * @public
+ * @private
  */
 
 /**
  * @typedef {object} FailRecord
  * @property {string} path The path of the file that failed to be registered.
  * @property {string} message Information about the failure.
  * @interface
+ * @private
  */
 
 module.exports = {

src/data/enums.js

@@ -1,10 +1,6 @@
-/**
- * @file
- * @ignore
- */
-
 /**
  * @module Enums
+ * @private
  */
 
 /**
@@ -13,6 +9,7 @@
  * @property {"commands"} Commands
  * @property {"events"} Events
  * @property {"modals"} Modals
+ * @private
  */
 const Modules = Object.freeze({
     Commands: "commands",
@@ -25,6 +22,7 @@ const Modules = Object.freeze({
  * @enum {number}
  * @property {0} Success
  * @property {1} Fail
+ * @private
  */
 const RecordStates = Object.freeze({
     Success: 0,

src/entities/command.js

@@ -1,11 +1,8 @@
 /* eslint-disable jsdoc/require-example */
-/**
- * @file
- * @ignore
- */
 
 /**
  * @module Command
+ * @memberof Entities
  */
 
 /**

src/entities/event.js

@@ -1,21 +1,20 @@
 /* eslint-disable jsdoc/require-example */
-/**
- * @file
- * @ignore
- */
 
 /**
  * @module Event
+ * @memberof Entities
  */
 
+const { Events } = require("discord.js");
+
 /**
- * @template {keyof ClientEvents} Key
+ * @template {Events} Key
  * @typedef {object} BotEventData
  * @property {Key} name The name of the event.
  */
 
 /**
- * @template {keyof ClientEvents} Key
+ * @template {Events} Key
  * @callback BotEventFunction
  * @param {DiscordBot} bot - The entire bot instance.
  * @param {...any} args

src/events/interactionCreate.js

@@ -1,14 +1,10 @@
-/**
- * @file
- * @ignore
- */
-
 const { applyStyle, asEmbed } = require("../func/style");
 
 /**
  * Handler of interactions called by the bot.
  * @param {BotCommandInteraction} interaction - The interaction to handle.
  * @returns {Promise<undefined>}
+ * @private
  */
 async function interactionCreate(interaction) {
     /**

src/events/ready.js

@@ -1,8 +1,4 @@
 /* eslint-disable jsdoc/require-example */
-/**
- * @file
- * @ignore
- */
 
 const { BotCommandDeployment } = require("../entities/command");
 
@@ -11,8 +7,8 @@ const { BotCommandDeployment } = require("../entities/command");
  * @param {BotCommandData} data - The command data deciding where to register the command.
  * @param {BotConfig} guildIds - The container of the server IDs.
  * @returns {string} The server ID.
- * @private
  * @throws {Error} - if data.deployment wasn't of the enum values.
+ * @private
  */
 function getGuildId(data, guildIds) {
     const globalGuildId = "0";

src/func/colour.js

@@ -1,10 +1,6 @@
-/**
- * @file
- * @ignore
- */
-
 /**
  * @module Colour
+ * @memberof Func
  */
 
 /**

src/func/style.js

@@ -1,10 +1,6 @@
-/**
- * @file
- * @ignore
- */
-
 /**
  * @module Style
+ * @memberof Func
  */
 
 const { APIEmbed } = require("discord.js");
@@ -15,7 +11,6 @@ const { asNumber } = require("./colour");
  * @param {string} text - The original text.
  * @param {{name:string,colour:number,logoUrl:URL}} brand - The brand to style the embed with.
  * @returns {APIEmbed} The resulting embed.
- * @private
  * @example
  * const brand = {colour: 0xffffff};
  * const result = asEmbed("halfbot", brand);

src/func/url.js

@@ -1,10 +1,6 @@
-/**
- * @file
- * @ignore
- */
-
 /**
  * @module Url
+ * @memberof Func
  */
 
 /**