Proyecto-Titulo/obelisk
3
0
Fork 0
Code Issues Pull Requests Releases 5 Wiki Activity

feature/documentation #12

Merged
cromer merged 26 commits from feature/documentation into develop 2023-02-03 23:21:29 -03:00
Conversation 0 Commits 26 Files Changed 25 +14 -14
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 8dd82abb55 - Show all commits

28
src/models/action.h
View File

@ -14,13 +14,13 @@ namespace obelisk
{ {
private: private:
/** /**
* @brief The ID of the action in the knowledge base. * @brief The ID of the Action in the knowledge base.
* *
*/ */
int id_; int id_;
/** /**
* @brief The name of the action. * @brief The name of the Action.
* *
*/ */
std::string name_; std::string name_;
@ -39,7 +39,7 @@ namespace obelisk
/** /**
* @brief Construct a new Action object. * @brief Construct a new Action object.
* *
* @param[in] id The ID of the action. * @param[in] id The ID of the Action.
*/ */
Action(int id) : Action(int id) :
id_(id), id_(id),
@ -50,7 +50,7 @@ namespace obelisk
/** /**
* @brief Construct a new Action object. * @brief Construct a new Action object.
* *
* @param[in] name The name of the action. * @param[in] name The name of the Action.
*/ */
Action(std::string name) : Action(std::string name) :
id_(0), id_(0),
@ -61,8 +61,8 @@ namespace obelisk
/** /**
* @brief Construct a new Action object. * @brief Construct a new Action object.
* *
* @param[in] id The ID of the action. * @param[in] id The ID of the Action.
* @param[in] name The name of the action. * @param[in] name The name of the Action.
*/ */
Action(int id, std::string name) : Action(int id, std::string name) :
id_(id), id_(id),
@ -71,37 +71,37 @@ namespace obelisk
} }
/** /**
* @brief Create the action table in the knowledge base. * @brief Create the Action table in the knowledge base.
* *
* @return const char* Returns the query used to create the table. * @return const char* Returns the query used to create the table.
*/ */
static const char* createTable(); static const char* createTable();
/** /**
* @brief Get the ID of the action. * @brief Get the ID of the Action.
* *
* @return int& Returns the ID. * @return int& Returns the ID.
*/ */
int& getId(); int& getId();
/** /**
* @brief Set the ID of the action. * @brief Set the ID of the Action.
* *
* @param[in] id Set the ID of the action. * @param[in] id Set the ID of the Action.
*/ */
void setId(int id); void setId(int id);
/** /**
* @brief Get the name of the action. * @brief Get the name of the Action.
* *
* @return std::string& The action name. * @return std::string& The Action name.
*/ */
std::string& getName(); std::string& getName();
/** /**
* @brief Set the name of the action. * @brief Set the name of the Action.
* *
* @param[in] name The name of the action. * @param[in] name The name of the Action.
*/ */
void setName(std::string name); void setName(std::string name);
}; };