From 95eeae927a426ae4c6c1a49b265a4782f4ad0172 Mon Sep 17 00:00:00 2001
From: Nina Dzugasova <dzugasova.nina@gmail.com>
Date: Fri, 30 Nov 2018 15:35:38 +0100
Subject: [PATCH] Added Assert documentation.

---
 src/TNL/Assert.h | 57 +++++++++++++++++++++++++++++++++++++++++++++++-
 src/TNL/Math.h   |  2 +-
 2 files changed, 57 insertions(+), 2 deletions(-)

diff --git a/src/TNL/Assert.h b/src/TNL/Assert.h
index 34b721fe6e..dabd69a973 100644
--- a/src/TNL/Assert.h
+++ b/src/TNL/Assert.h
@@ -34,20 +34,75 @@
 
 // empty macros for optimized build
 /**
- * \brief Assert that the expression \e val evaluates to \e true.
+ * \brief Asserts that the expression \e val evaluates to \e true.
  *
  * The assertion succeeds if, and only if, \e val evaluates to equal to \e true.
  * On success the test continues without any side effects.
  * On failure the test is terminated with the error message \e msg.
  */
 #define TNL_ASSERT_TRUE( val, msg )
+/**
+ * \brief Asserts that the expression \e val evaluates to \e false.
+ *
+ * The assertion succeeds if, and only if, \e val evaluates to equal to \e false.
+ * On success the test continues without any side effects.
+ * On failure the test is terminated with the error message \e msg.
+ */
 #define TNL_ASSERT_FALSE( val, msg )
+/**
+ * \brief Asserts that the expression \e val1 is equal to \e val2.
+ *
+ * The assertion succeeds if, and only if, \e val1 and \e val2 are equal.
+ * On success the test continues without any side effects.
+ * On failure the test is terminated with the error message \e msg.
+ */
 #define TNL_ASSERT_EQ( val1, val2, msg )
+/**
+ * \brief Asserts that the expression \e val1 is not equal to \e val2.
+ *
+ * The assertion succeeds if, and only if, \e val1 and \e val2 are not equal.
+ * On success the test continues without any side effects.
+ * On failure the test is terminated with the error message \e msg.
+ */
 #define TNL_ASSERT_NE( val1, val2, msg )
+/**
+ * \brief Asserts that the expression \e val1 is less than or equal to \e val2.
+ *
+ * The assertion succeeds if, and only if, \e val1 is less than or equal to \e val2.
+ * On success the test continues without any side effects.
+ * On failure the test is terminated with the error message \e msg.
+ */
 #define TNL_ASSERT_LE( val1, val2, msg )
+/**
+ * \brief Asserts that the expression \e val1 is less than \e val2.
+ *
+ * The assertion succeeds if, and only if, \e val1 is less than \e val2.
+ * On success the test continues without any side effects.
+ * On failure the test is terminated with the error message \e msg.
+ */
 #define TNL_ASSERT_LT( val1, val2, msg )
+/**
+ * \brief Asserts that the expression \e val1 is greater than or equal to \e val2.
+ *
+ * The assertion succeeds if, and only if, \e val1 is greater than or equal to \e val2.
+ * On success the test continues without any side effects.
+ * On failure the test is terminated with the error message \e msg.
+ */
 #define TNL_ASSERT_GE( val1, val2, msg )
+/**
+ * \brief Asserts that the expression \e val1 is greater than \e val2.
+ *
+ * The assertion succeeds if, and only if, \e val1 is greater than \e val2.
+ * On success the test continues without any side effects.
+ * On failure the test is terminated with the error message \e msg.
+ */
 #define TNL_ASSERT_GT( val1, val2, msg )
+/**
+ * \brief Asserts that the specified \e ___tnl__assert_condition is valid.
+ *
+ * The assertion succeeds if, and only if, ___tnl__assert_condition is valid.
+ * On success the test continues without any side effects.
+ * On failure the test is terminated with the error message \e ___tnl__assert_command.
 #define TNL_ASSERT( ___tnl__assert_condition, ___tnl__assert_command )
 
 #else /* #ifdef NDEBUG */
diff --git a/src/TNL/Math.h b/src/TNL/Math.h
index 34cd91eebc..12cab18d8c 100644
--- a/src/TNL/Math.h
+++ b/src/TNL/Math.h
@@ -215,7 +215,7 @@ inline int roundUpDivision( const int num, const int div )
 }
 
 /**
- * \brief This function rounds \e number to the nearest multiple of number \e multiple.
+ * \brief This function rounds up \e number to the nearest multiple of number \e multiple.
  *
  * @param number Integer we want to round.
  * @param multiple Integer.
-- 
GitLab