diff --git a/querying/Doxyfile.txt b/querying/Doxyfile.txt index bf531db9dad73978e2adabeec61ade162051b2fe..dc211d5d333020501f29398713641921c3eb46af 100644 --- a/querying/Doxyfile.txt +++ b/querying/Doxyfile.txt @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Vector model" +PROJECT_NAME = "Vector model of information retrieval - Querying" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version diff --git a/querying/src/exceptions/Exceptions.h b/querying/src/exceptions/Exceptions.h index efe4511d0312ae3bbd74e093ffa6599a3d696b9a..2f5fa28c53c5d1bb960431a57cd6a54f4d32cd6d 100644 --- a/querying/src/exceptions/Exceptions.h +++ b/querying/src/exceptions/Exceptions.h @@ -4,9 +4,15 @@ #include <exception> #include <string> +/** + * An exception that is thrown when the end of an inverted index list is reached (list is exhausted) + */ class EndOfIndexException : public std::exception { }; +/** + * An exception that is thrown when a document ID cannot be found + */ class IDNotFoundException : public std::exception { }; diff --git a/querying/src/space/Space.h b/querying/src/space/Space.h index 379ac80d10548362a8e1bcfc36d06a93c3d010ce..adfa5f1aead05d6bf9079f7860cd964faf2dc512 100644 --- a/querying/src/space/Space.h +++ b/querying/src/space/Space.h @@ -10,7 +10,7 @@ #include "../query/Query.h" /** - * @brief Class representing the vector space of the collection + * @brief A class representing the vector space of the collection * * @author koristo1@fit.cvut.cz */