Skip to content

Commit 006d021

Browse files
committed
Added Doxygen documentation
1 parent 5cbc435 commit 006d021

5 files changed

Lines changed: 2881 additions & 1 deletion

File tree

capiocl.hpp

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ class Parser {
429429
};
430430

431431
/**
432-
* Custom exception for errors occurring within the Parser component
432+
* @brief Custom exception thrown when parsing a CAPIO-CL configuration file by @ref Parser
433433
*/
434434
class ParserException : public std::exception {
435435
std::string message;
@@ -438,9 +438,18 @@ class ParserException : public std::exception {
438438
explicit ParserException(const std::string &msg) : message(msg) {
439439
print_message(CLI_LEVEL_ERROR, msg);
440440
}
441+
442+
/**
443+
* Get the description of the error causing the exception
444+
* @return
445+
*/
441446
const char *what() const noexcept override { return message.c_str(); }
442447
};
443448

449+
/**
450+
* @brief Dump the current loaded CAPIO-CL configuration from class @ref Engine
451+
* to a CAPIO-CL configuration file.
452+
*/
444453
class Serializer {
445454
public:
446455
/**

doxygen/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
generated/**
2+
Doxyfile

0 commit comments

Comments
 (0)