include: Document unit_test*() macros.

diff --git a/include/cmocka.h b/include/cmocka.h
index f99706bd0ab85b95b49cc708004b5acd102a4c57..ec72e58a69124cd4a6e7498e61036e874e359f11 100755 (executable)
--- a/include/cmocka.h
+++ b/include/cmocka.h
@@ -425,14 +425,18 @@ int run_test(#function);
 #define run_test(f) _run_test(#f, f, NULL, UNIT_TEST_FUNCTION_TYPE_TEST, NULL)
 #endif
 
-/* Initializes a UnitTest structure. */
+/** Initializes a UnitTest structure. */
 #define unit_test(f) { #f, f, UNIT_TEST_FUNCTION_TYPE_TEST }
+
+/** Initializes a UnitTest structure with a setup function. */
 #define unit_test_setup(test, setup) \
     { #test "_" #setup, setup, UNIT_TEST_FUNCTION_TYPE_SETUP }
+
+/** Initializes a UnitTest structure with a teardown function. */
 #define unit_test_teardown(test, teardown) \
     { #test "_" #teardown, teardown, UNIT_TEST_FUNCTION_TYPE_TEARDOWN }
 
-/*
+/**
  * Initialize an array of UnitTest structures with a setup function for a test
  * and a teardown function.  Either setup or teardown can be NULL.
  */