Update documentation

This commit is contained in:
2023-12-04 22:23:55 +01:00
parent d318491dfe
commit b20fe658b9
15 changed files with 132 additions and 171 deletions

View File

@@ -8,7 +8,7 @@
* @brief A small test library.
*
* @details This a small testing library that is tailored for the needs of the
* project. Anything that is in the details namespace should not be used
* project. Anything that is in the details namespace should not be used
* directly, or else it might cause undefined behavior if not used correctly.
*
* @bug No known bugs
@@ -32,6 +32,7 @@
details::m_assert(expr, #expr, __METHOD_NAME__, __FILE__, __LINE__, msg)
namespace details {
/** @brief Test an expression, confirm that test is ok, or abort execution.
*
* @details This function takes in an expression and prints an OK message if
@@ -49,6 +50,7 @@ void m_assert(bool expr, std::string expr_str, std::string func,
} // namespace details
namespace testlib {
/** @brief Test if two armadillo matrices/vectors are close to each other.
*
* @details This function takes in 2 matrices/vectors and checks if they are