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

add missing class documentation and link manual to it

This commit is contained in:
Chris Cromer 2022-12-10 18:23:39 -03:00
parent f810a25c0b
commit b908bdf89b
Signed by: cromer
GPG Key ID: FA91071797BEEEC2
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/knowledge_base.h
View File

@ -14,6 +14,11 @@
namespace obelisk namespace obelisk
{ {
/**
* @brief The KnowledgeBase class represents a collection of facts, rules,
* actions, and related language connectors.
*
*/
class KnowledgeBase class KnowledgeBase
{ {
private: private:
@ -52,7 +57,7 @@ namespace obelisk
public: public:
/** /**
* @brief Construct a new Knowledge Base object. * @brief Construct a new KnowledgeBase object.
* *
* @param[in] filename The name of the file to save the knowledge * @param[in] filename The name of the file to save the knowledge
* base as. * base as.
@ -61,7 +66,7 @@ namespace obelisk
KnowledgeBase(const char* filename, int flags); KnowledgeBase(const char* filename, int flags);
/** /**
* @brief Construct a new Knowledge Base object. * @brief Construct a new KnowledgeBase object.
* *
* @param[in] filename The name of the file to save the knowledge * @param[in] filename The name of the file to save the knowledge
* base as. * base as.
@ -73,7 +78,7 @@ namespace obelisk
} }
/** /**
* @brief Destroy the Knowledge Base object. * @brief Destroy the KnowledgeBase object.
* *
* This will close the opened knowledge base before destroying it. * This will close the opened knowledge base before destroying it.
*/ */
@ -169,7 +174,7 @@ namespace obelisk
public: public:
/** /**
* @brief Construct a new Knowledge Base Exception object. * @brief Construct a new KnowledgeBaseException object.
* *
*/ */
KnowledgeBaseException() : KnowledgeBaseException() :
@ -178,7 +183,7 @@ namespace obelisk
} }
/** /**
* @brief Construct a new Knowledge Base Exception object. * @brief Construct a new KnowledgeBaseException object.
* *
* @param[in] errorMessage The error message given when thrown. * @param[in] errorMessage The error message given when thrown.
*/ */