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

add in and out docuementation to a few of the methods

This commit is contained in:
Chris Cromer 2022-12-10 18:06:30 -03:00
parent 991fe84c01
commit d6a7913993
Signed by: cromer
GPG Key ID: FA91071797BEEEC2
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/knowledge_base.h
View File

@ -82,45 +82,48 @@ namespace obelisk
/** /**
* @brief Add entities to the knowledge base. * @brief Add entities to the knowledge base.
* *
* @param[in] entities The entities to add. * @param[in,out] entities The entities to add. If the insert is
* successful it will have a row ID, if not the ID will be 0.
*/ */
void addEntities(std::vector<obelisk::Entity>& entities); void addEntities(std::vector<obelisk::Entity>& entities);
/** /**
* @brief Add verbs to the knowledge base. * @brief Add verbs to the knowledge base.
* *
* @param[in] verbs The verbs to add. * @param[in,out] verbs The verbs to add. If the insert is
* successful it will have a row ID, if not the ID will be 0.
*/ */
void addVerbs(std::vector<obelisk::Verb>& verbs); void addVerbs(std::vector<obelisk::Verb>& verbs);
/** /**
* @brief Add facts to the database. * @brief Add facts to the database.
* *
* @param[in] facts The facts to add. * @param[in,out] facts The facts to add. If the insert is
* successful it will have a row ID, if not the ID will be 0.
*/ */
void addFacts(std::vector<obelisk::Fact>& facts); void addFacts(std::vector<obelisk::Fact>& facts);
/** /**
* @brief Get an entity object based on the ID it contains. * @brief Get an entity object based on the ID it contains.
* *
* @param[out] entity The Entity object should contain just the ID * @param[in,out] entity The Entity object should contain just the
* and the rest will be filled in. * ID and the rest will be filled in.
*/ */
void getEntity(obelisk::Entity& entity); void getEntity(obelisk::Entity& entity);
/** /**
* @brief Get a verb object based on the ID it contains. * @brief Get a verb object based on the ID it contains.
* *
* @param[out] verb The Verb object should contain just the ID and * @param[in,out] verb The Verb object should contain just the ID
* the rest will be filled in. * and the rest will be filled in.
*/ */
void getVerb(obelisk::Verb& verb); void getVerb(obelisk::Verb& verb);
/** /**
* @brief Get a fact object based on the ID it contains. * @brief Get a fact object based on the ID it contains.
* *
* @param[out] fact The fact object should contain just the ID and * @param[in,out] fact The fact object should contain just the ID
* the rest will be filled in. * and the rest will be filled in.
*/ */
void getFact(obelisk::Fact& fact); void getFact(obelisk::Fact& fact);