From 8933ec28093f46ff23a96fc97d2a25a51eb54d00 Mon Sep 17 00:00:00 2001
From: MangosArentLiterature
 <58055358+MangosArentLiterature@users.noreply.github.com>
Date: Sun, 18 Apr 2021 20:30:11 -0500
Subject: [PATCH] Clean up documentation, remove RollType

- Cleans up documentation for cmdRoll cmdRollP and diceThrower()
- Removes the obsolete enum RollType
---
 include/aoclient.h | 28 ++++++----------------------
 1 file changed, 6 insertions(+), 22 deletions(-)

diff --git a/include/aoclient.h b/include/aoclient.h
index 5493f06..2b325d8 100644
--- a/include/aoclient.h
+++ b/include/aoclient.h
@@ -326,17 +326,6 @@ class AOClient : public QObject {
         LOCKED //!< The packet contains updates about what areas are locked.
     };
 
-    /**
-     * @brief Used for the common parts of the dice rolling commands, to determine where the function should go after the common functionality.
-     *
-     * @see AOClient::diceThrower
-     */
-    enum RollType {
-        ROLL, //!< The roll is a simple numerical roll, should be announced in the area.
-        ROLLP, //!< The roll is a numerical roll, but private, the result should only be told to the caller.
-        ROLLA //!< The roll is an ability roll, the values must be read out of the ability die configs.
-    };
-
     /**
      * @brief Handles an incoming packet, checking for authorisation and minimum argument count.
      *
@@ -1190,7 +1179,7 @@ class AOClient : public QObject {
     void cmdFlip(int argc, QStringList argv);
 
     /**
-     * @brief Rolls dice, summing the results.
+     * @brief Rolls dice and sends the results.
      *
      * @details The first argument is the **amount of faces** each die should have.
      * The second argument is the **amount of dice** that should be rolled.
@@ -1747,18 +1736,13 @@ class AOClient : public QObject {
     int genRand(int min, int max);
 
     /**
-     * @brief A convenience function unifying the various dice-rolling methods.
+     * @brief A convenience function for rolling dice.
      *
-     * @internal
-     *  Babby's first code. <3
-     * @endinternal
+     * @param argc The amount of arguments.
      *
-     * @param argc The amount of arguments arriving to the function through a command call,
-     * equivalent to `argv.size()`.
-     * See @ref commandArgc "CommandInfo's `action`'s first parameter".
-     * @param argv The list of arguments passed to the function through a command call.
-     * See @ref commandArgv "CommandInfo's `action`'s second parameter".
-     * @param Type The type of the dice-rolling being done.
+     * @param argv Stringlist of the arguments given by the client.
+     *
+     * @param p_roll Bool to determine of a roll is private or not.
      */
     void diceThrower(int argc, QStringList argv, bool p_roll);