From 0aa772ea8975a5de7136bdf2dc0be11c269f1e56 Mon Sep 17 00:00:00 2001
From: MangosArentLiterature
 <58055358+MangosArentLiterature@users.noreply.github.com>
Date: Tue, 6 Apr 2021 13:49:08 -0500
Subject: [PATCH] Add documentation for the judgelog, updateJudgeLog(), and the
 /judgelog command.

---
 include/aoclient.h  | 16 ++++++++++++++++
 include/area_data.h |  5 +++++
 2 files changed, 21 insertions(+)

diff --git a/include/aoclient.h b/include/aoclient.h
index 83756da..f7eb72d 100644
--- a/include/aoclient.h
+++ b/include/aoclient.h
@@ -1389,6 +1389,13 @@ class AOClient : public QObject {
      */
     void cmd8Ball(int argc, QStringList argv);
 
+    /**
+    * @brief Sends an out-of-character message with the judgelog of an area.
+    *
+    * @details No arguments.
+    *
+    * @iscommand
+    */
     void cmdJudgeLog(int argc, QStringList argv);
 
     ///@}
@@ -1633,6 +1640,15 @@ class AOClient : public QObject {
      */
     QString last_message;
 
+    /**
+     * @brief A helper function to add recorded packets to an area's judgelog.
+     *
+     * @param area Pointer to the area where the packet was sent.
+     *
+     * @param client Pointer to the client that sent the packet.
+     *
+     * @param action String containing the info that is being recorded.
+     */
     void updateJudgeLog(AreaData* area, AOClient* client, QString action);
 };
 
diff --git a/include/area_data.h b/include/area_data.h
index b506b82..d36d743 100644
--- a/include/area_data.h
+++ b/include/area_data.h
@@ -273,6 +273,11 @@ class AreaData : public QObject {
     EvidenceMod evi_mod;
     QMap<QString, QString> notecards;
 
+    /**
+    * @brief The judgelog of an area.
+    *
+    * @details This list contains up to 10 recorded packets of the most recent judge actions (WT/CE or penalty updates) in an area.
+    */
     QStringList judgelog;
 };