adjust and add comments for doxygen

diff --git a/src/ccunit/CCUnitAssert.h b/src/ccunit/CCUnitAssert.h
index 865efcc..d6ad658 100644 (file)
--- a/src/ccunit/CCUnitAssert.h
+++ b/src/ccunit/CCUnitAssert.h
@@ -80,7 +80,7 @@ typedef int64_t quad_t;                               /**< quad_t */
 #else  /* !CCUNIT_HAVE_INT64_T */
 #if CCUNIT_HAVE_LONG_LONG
 #define CCUNIT_HAVE_QUAD_T 1
-typedef long long quad_t;                      /**< u_quad_t */
+typedef long long quad_t;                      /**< quad_t */
 #endif /* CCUNIT_HAVE_LONG_LONG */
 #endif /* CCUNIT_HAVE_INT64_T */
 #endif /* !CCUNIT_HAVE_QUAD_T */
@@ -88,11 +88,11 @@ typedef long long quad_t;                   /**< u_quad_t */
 #ifndef CCUNIT_HAVE_U_QUAD_T
 #ifdef CCUNIT_HAVE_U_INT64_T
 #define CCUNIT_HAVE_U_QUAD_T 1
-typedef u_int64_t u_quad_t;
+typedef u_int64_t u_quad_t;                    /**< u_quad_t */
 #else  /* !CCUNIT_HAVE_U_INT64_T */
 #ifdef CCUNIT_HAVE_LONG_LONG
 #define CCUNIT_HAVE_U_QUAD_T 1
-typedef unsigned long long u_quad_t;
+typedef unsigned long long u_quad_t;           /**< u_quad_t */
 #endif /* CCUNIT_HAVE_LONG_LONG */
 #endif /* CCUNIT_HAVE_U_INT64_T */
 #endif /* !CCUNIT_HAVE_U_QUAD_T */
@@ -104,6 +104,8 @@ typedef const void* _ccunit_obj_t;          /**< object type */
 /**
  * @name Declare assert test types
  * @{
+ */
+/**
  * Asserts that a condition is true. If it isn't it longjmp with
  * _ccunit_runTest_env.
  *
@@ -155,9 +157,9 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
  */
 #define CCUNIT_ASSERT(COND) ccunit_assert (__FILE__, __LINE__, COND, #COND)
 
-/** @name Assert Macros
+/**
+ * @name Assert Macros
  * The assert test macros.
- * @ingroup Assertions 
  * @{
  */
 /**
@@ -169,6 +171,7 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
  * @param OP test operator.
  * @param ACTUAL actual value.
  * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
  */
 #define CCUNIT_ASSERT_TEST(TYP, EXPECT, OP, ACTUAL)                    \
   do {                                                                 \
@@ -179,33 +182,153 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
                                ex, ac);                                \
   } while (0)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_INT(EXPECT, OP, ACTUAL)             \
   CCUNIT_ASSERT_TEST (int, EXPECT, OP, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_UINT(EXPECT, OP, ACTUAL)            \
   CCUNIT_ASSERT_TEST (u_int, EXPECT, OP, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_LONG(EXPECT, OP, ACTUAL)            \
   CCUNIT_ASSERT_TEST (long, EXPECT, OP, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_ULONG(EXPECT, OP, ACTUAL)           \
   CCUNIT_ASSERT_TEST (u_long, EXPECT, OP, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_SHORT(EXPECT, OP, ACTUAL)           \
   CCUNIT_ASSERT_TEST (short, EXPECT, OP, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_USHORT(EXPECT, OP, ACTUAL)          \
   CCUNIT_ASSERT_TEST (u_short, EXPECT, OP, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_DOUBLE(EXPECT, OP, ACTUAL)          \
   CCUNIT_ASSERT_TEST (double, EXPECT, OP, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_FLOAT(EXPECT, OP, ACTUAL)           \
   CCUNIT_ASSERT_TEST (float, EXPECT, OP, ACTUAL)
 #if CCUNIT_HAVE_QUAD_T
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_QUAD(EXPECT, OP, ACTUAL)            \
   CCUNIT_ASSERT_TEST (quad_t, EXPECT, OP, ACTUAL)
 #endif
 #if CCUNIT_HAVE_U_QUAD_T
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_UQUAD(EXPECT, OP, ACTUAL)           \
   CCUNIT_ASSERT_TEST (u_quad_t, EXPECT, OP, ACTUAL)
 #endif
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_PTR(EXPECT, OP, ACTUAL)             \
   CCUNIT_ASSERT_TEST (_ccunit_ptr_t, EXPECT, OP, ACTUAL)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_STR(EXPECT, OP, ACTUAL)                     \
   do {                                                                 \
     const _ccunit_str_t ex = (EXPECT);                                 \
@@ -215,6 +338,17 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
                                      strcmp(ex, ac) OP 0, condstr, ex, ac); \
   } while (0)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @param N length to compare.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_NSTR(EXPECT, OP, ACTUAL, N)                 \
   do {                                                                 \
     const _ccunit_str_t ex = (EXPECT);                                 \
@@ -227,6 +361,16 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
                                      ex, ac);                          \
   } while (0)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_CASE_STR(EXPECT, OP, ACTUAL)                        \
   do {                                                                 \
     const _ccunit_str_t ex = (EXPECT);                                 \
@@ -239,6 +383,17 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
                                      ex, ac);                          \
   } while (0)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @param N length to compare.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_CASE_NSTR(EXPECT, OP, ACTUAL, N)            \
   do {                                                                 \
     const _ccunit_str_t ex = (EXPECT);                                 \
@@ -251,6 +406,17 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
                                      ex, ac);                          \
   } while (0)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param EXPECT expect value.
+ * @param OP test operator.
+ * @param ACTUAL actual value.
+ * @param TOSTR pointer to function of converting to string.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
+ */
 #define CCUNIT_ASSERT_TEST_OBJ(EXPECT, OP, ACTUAL, TOSTR)              \
   do {                                                                 \
     const _ccunit_obj_t ex = (EXPECT);                                 \
@@ -272,6 +438,7 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
  * @param EXPECT expect value.
  * @param ACTUAL actual value.
  * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions 
  *
  * @note This macro has the possibility that a side effect happens in
  * the argument EXPECT and ACTUAL.
@@ -284,95 +451,446 @@ extern void ccunit_assert_test__ccunit_obj_t (const char* file, unsigned int lin
                                (#CONDITION), ex, ac);                  \
   } while (0)
 
-/** @name Assert Condition Macros
+/**
+ * @name Assert Condition Macros
  * The assert condition macros.
- * @ingroup Assertions 
  * @{
  */
+/**
+ * Asserts that a pointer is NULL. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual pointer value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_NULL(ACTUAL)             \
   CCUNIT_ASSERT_TEST_PTR(NULL, ==, ACTUAL)
+
+/**
+ * Asserts that a pointer is not NULL. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_NOT_NULL(ACTUAL)         \
   CCUNIT_ASSERT_TEST_PTR(NULL, !=, ACTUAL)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_EQ_INT(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_INT (EXPECT, ==, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_NE_INT(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_INT (EXPECT, !=, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LT_INT(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_INT (EXPECT, <, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LE_INT(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_INT (EXPECT, <=, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GT_INT(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_INT (EXPECT, >, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GE_INT(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_INT (EXPECT, >=, ACTUAL)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_EQ_UINT(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_UINT (EXPECT, ==, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_NE_UINT(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_UINT (EXPECT, !=, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LT_UINT(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_UINT (EXPECT, <, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LE_UINT(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_UINT (EXPECT, <=, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GT_UINT(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_UINT (EXPECT, >, ACTUAL)
+
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GE_UINT(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_UINT (EXPECT, >=, ACTUAL)
 
 #if CCUNIT_HAVE_QUAD_T
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_EQ_QUAD(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_QUAD (EXPECT, ==, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_NE_QUAD(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_QUAD (EXPECT, !=, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LT_QUAD(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_QUAD (EXPECT, <, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LE_QUAD(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_QUAD (EXPECT, <=, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GT_QUAD(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_QUAD (EXPECT, >, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GE_QUAD(EXPECT, ACTUAL)  \
   CCUNIT_ASSERT_TEST_QUAD (EXPECT, >=, ACTUAL)
 #endif
 
 #if CCUNIT_HAVE_U_QUAD_T
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_EQ_UQUAD(EXPECT, ACTUAL) \
   CCUNIT_ASSERT_TEST_UQUAD (EXPECT, ==, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_NE_UQUAD(EXPECT, ACTUAL) \
   CCUNIT_ASSERT_TEST_UQUAD (EXPECT, !=, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LT_UQUAD(EXPECT, ACTUAL) \
   CCUNIT_ASSERT_TEST_UQUAD (EXPECT, <, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LE_UQUAD(EXPECT, ACTUAL) \
   CCUNIT_ASSERT_TEST_UQUAD (EXPECT, <=, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GT_UQUAD(EXPECT, ACTUAL) \
   CCUNIT_ASSERT_TEST_UQUAD (EXPECT, >, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GE_UQUAD(EXPECT, ACTUAL) \
   CCUNIT_ASSERT_TEST_UQUAD (EXPECT, >=, ACTUAL)
 #endif
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_EQ_STR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_STR (EXPECT, ==, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_NE_STR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_STR (EXPECT, !=, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LT_STR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_STR (EXPECT, <, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LE_STR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_STR (EXPECT, <=, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GT_STR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_STR (EXPECT, >, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GE_STR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_STR (EXPECT, >=, ACTUAL)
 
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_EQ_PTR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_PTR (EXPECT, ==, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_NE_PTR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_PTR (EXPECT, !=, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LT_PTR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_PTR (EXPECT, <, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_LE_PTR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_PTR (EXPECT, <=, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GT_PTR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_PTR (EXPECT, >, ACTUAL)
+/**
+ * Asserts that a condition is true. If it isn't it longjmp with
+ * _ccunit_runTest_env.
+ *
+ * @param ACTUAL actual value.
+ * @param EXPECT expect value.
+ * @throws _ccunit_runTest_env If condition is false.
+ * @ingroup Assertions
+ */
 #define CCUNIT_ASSERT_GE_PTR(EXPECT, ACTUAL)   \
   CCUNIT_ASSERT_TEST_PTR (EXPECT, >=, ACTUAL)