add: doxygen info to loop and shuffle;update: README.md

This commit adds doxygen information to loop and shuffle functions and updates README.md to follow our newest coding style.

README.md

@@ -67,7 +67,7 @@ client.on('messageCreate', async (message) => {
   const commandName = message.content.split(' ')[0].toLowerCase().substring(prefix.length)
   const args = message.content.split(' ').slice(1).join(' ')
 
-  if (commandName == 'decodetrack') {
+  if (commandName === 'decodetrack') {
     const player = new FastLink.player.Player(message.guild.id)
 
     if (player.playerCreated() === false) {
@@ -83,10 +83,10 @@ client.on('messageCreate', async (message) => {
     return;
   }
 
-  if (commandName == 'record') {
+  if (commandName === 'record') {
     const player = new FastLink.player.Player(message.guild.id)
 
-    if (player.playerCreated() == false) {
+    if (player.playerCreated() === false) {
       message.channel.send('No player found.')
 
       return;
@@ -105,10 +105,10 @@ client.on('messageCreate', async (message) => {
     message.channel.send('Started recording. Be aware: This will record everything you say in the voice channel, even if the bot is deaf. Server deaf the bot if you don\'t want to be recorded by any chances.')
   }
 
-  if (commandName == 'stoprecord') {
+  if (commandName === 'stoprecord') {
     const player = new FastLink.player.Player(message.guild.id)
 
-    if (player.playerCreated() == false) {
+    if (player.playerCreated() === false) {
       message.channel.send('No player found.')
 
       return;
@@ -119,7 +119,7 @@ client.on('messageCreate', async (message) => {
     message.channel.send('Stopped recording.')
   }
 
-  if (commandName == 'play') {
+  if (commandName === 'play') {
     if (!message.member.voice.channel) {
       message.channel.send('You must be in a voice channel.')
 
@@ -178,7 +178,7 @@ client.on('messageCreate', async (message) => {
       return;
     }
 
-    if (track.loadType == 'search') {
+    if (track.loadType === 'search') {
       player.update({
         track: {
           encoded: track.data[0].encoded
@@ -191,7 +191,7 @@ client.on('messageCreate', async (message) => {
     }
   }
 
-  if (commandName == 'volume') {
+  if (commandName === 'volume') {
     const player = new FastLink.player.Player(message.guild.id)
 
     if (player.playerCreated() === false) {
@@ -209,7 +209,7 @@ client.on('messageCreate', async (message) => {
     return;
   }
 
-  if (commandName == 'pause') {
+  if (commandName === 'pause') {
     const player = new FastLink.player.Player(message.guild.id)
 
     if (player.playerCreated() === false) {
@@ -225,7 +225,7 @@ client.on('messageCreate', async (message) => {
     return;
   }
 
-  if (commandName == 'resume') {
+  if (commandName === 'resume') {
     const player = new FastLink.player.Player(message.guild.id)
 
     if (player.playerCreated() === false) {
@@ -241,7 +241,7 @@ client.on('messageCreate', async (message) => {
     return;
   }
 
-  if (commandName == 'skip') {
+  if (commandName === 'skip') {
     const player = new FastLink.player.Player(message.guild.id)
 
     if (player.playerCreated() === false) {
@@ -258,7 +258,7 @@ client.on('messageCreate', async (message) => {
     return;
   }
 
-  if (commandName == 'stop') {
+  if (commandName === 'stop') {
     const player = new FastLink.player.Player(message.guild.id)
 
     if (player.playerCreated() === false) {

index.js

@@ -348,27 +348,34 @@ class Player {
     return Players[this.guildId].queue
   }
 
-  loop() {
+  /**
+   * Sets the loop state of the player.
+   *
+   * @param loop The loop state to set.
+   * @return The loop state of the player.
+   */
+  loop(loop) {
     if (!Config.queue) throw new Error('Queue is disabled.')
 
-    let loop = null
-    switch (Players[this.guildId].loop){
-      case 'track': loop = 'track'; break;
-      case 'queue': loop = 'queue'; break;
-      case 'off': loop = 'off'; break;
-      default: throw new Error('Invalid option. Available options: track, queue, off')
-    }
+    if (![ 'track', 'queue', null ].includes(loop))
+      throw new Error('Loop must be track, queue, or null.')
 
     return Players[this.guildId].loop = loop
   }
 
+  /**
+   * Shuffles the queue of tracks.
+   * 
+   * @return The shuffled queue of tracks, or false if there are less than 3 tracks in the queue.
+   * @throws Error If the queue is disabled.
+   */
   shuffle() {
     if (!Config.queue) throw new Error('Queue is disabled.')
 
     if (Players[this.guildId].queue.length < 3)
       return false
 
-    PLayers[this.guild].queue.forEach((_, i) => {
+    Players[this.guildId].queue.forEach((_, i) => {
       const j = Math.floor(Math.random() * (i + 1))
       const temp = Players[this.guildId].queue[i]
       Players[this.guildId].queue[i] = Players[this.guildId].queue[j]