From 26a861772c956f152c98228bd70d3875f1176360 Mon Sep 17 00:00:00 2001
From: Chris Cromer <chris@cromer.cl>
Date: Sat, 10 Dec 2022 18:13:01 -0300
Subject: [PATCH] add action documentation

---
 src/models/action.h | 61 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/src/models/action.h b/src/models/action.h
index 7940f2b..e6bcfa8 100644
--- a/src/models/action.h
+++ b/src/models/action.h
@@ -5,43 +5,104 @@
 
 namespace obelisk
 {
+    /**
+     * @brief The Action model represents an action to take when a fact is true
+     * or false.
+     *
+     */
     class Action
     {
         private:
+            /**
+             * @brief The ID of the action in the knowledge base.
+             *
+             */
             int id_;
+
+            /**
+             * @brief The name of the action.
+             *
+             */
             std::string name_;
 
         public:
+            /**
+             * @brief Construct a new Action object.
+             *
+             */
             Action() :
                 id_(0),
                 name_("")
             {
             }
 
+            /**
+             * @brief Construct a new Action object.
+             *
+             * @param[in] id The ID of the action.
+             */
             Action(int id) :
                 id_(id),
                 name_("")
             {
             }
 
+            /**
+             * @brief Construct a new Action object.
+             *
+             * @param[in] name The name of the action.
+             */
             Action(std::string name) :
                 id_(0),
                 name_(name)
             {
             }
 
+            /**
+             * @brief Construct a new Action object.
+             *
+             * @param[in] id The ID of the action.
+             * @param[in] name The name of the action.
+             */
             Action(int id, std::string name) :
                 id_(id),
                 name_(name)
             {
             }
 
+            /**
+             * @brief Create the action table in the knowledge base.
+             *
+             * @return const char* Returns the query used to create the table.
+             */
             static const char* createTable();
 
+            /**
+             * @brief Get the ID of the action.
+             *
+             * @return int& Returns the ID.
+             */
             int& getId();
+
+            /**
+             * @brief Set the ID of the action.
+             *
+             * @param[in] id Set the ID of the action.
+             */
             void setId(int id);
 
+            /**
+             * @brief Get the name of the action.
+             *
+             * @return std::string& The action name.
+             */
             std::string& getName();
+
+            /**
+             * @brief Set the name of the action.
+             *
+             * @param[in] name The name of the action.
+             */
             void setName(std::string name);
     };
 } // namespace obelisk