From b908bdf89bf6cd80b1b4abcff14224fe2ed591c7 Mon Sep 17 00:00:00 2001 From: Chris Cromer Date: Sat, 10 Dec 2022 18:23:39 -0300 Subject: [PATCH] add missing class documentation and link manual to it --- src/knowledge_base.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/src/knowledge_base.h b/src/knowledge_base.h index 9fdf450..f7d030f 100644 --- a/src/knowledge_base.h +++ b/src/knowledge_base.h @@ -14,6 +14,11 @@ namespace obelisk { + /** + * @brief The KnowledgeBase class represents a collection of facts, rules, + * actions, and related language connectors. + * + */ class KnowledgeBase { private: @@ -52,7 +57,7 @@ namespace obelisk 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 * base as. @@ -61,7 +66,7 @@ namespace obelisk 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 * 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. */ @@ -169,7 +174,7 @@ namespace obelisk public: /** - * @brief Construct a new Knowledge Base Exception object. + * @brief Construct a new KnowledgeBaseException object. * */ 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. */