aboutsummaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorGertjan van den Burg <burg@ese.eur.nl>2016-10-06 19:14:58 +0200
committerGertjan van den Burg <burg@ese.eur.nl>2016-10-06 19:14:58 +0200
commit664a331115f3f385d7136745d0b4dd420946929f (patch)
treec910a216bee924fa8239a04f3b91189542b99f05 /tests
parentmake use of the fact that the first element of z_i is always 1 (diff)
downloadgensvm-664a331115f3f385d7136745d0b4dd420946929f.tar.gz
gensvm-664a331115f3f385d7136745d0b4dd420946929f.zip
documentation fixes
Diffstat (limited to 'tests')
-rw-r--r--tests/include/dbg.h12
-rw-r--r--tests/include/minunit.h13
2 files changed, 25 insertions, 0 deletions
diff --git a/tests/include/dbg.h b/tests/include/dbg.h
index 0401ea1..71137ba 100644
--- a/tests/include/dbg.h
+++ b/tests/include/dbg.h
@@ -1,3 +1,15 @@
+/**
+ * @file dbg.h
+ * @brief Debug macros for the minunit framework
+ * @author Zed Shaw
+ *
+ * @details
+ * These debug macros come from Zed Shaw's book Learn C The Hard Way, and are
+ * used for the testing framework of GenSVM.
+ *
+ * @sa minunit.h
+ */
+
#ifndef __dbg_h__
#define __dbg_h__
diff --git a/tests/include/minunit.h b/tests/include/minunit.h
index 0fe8898..9e2328f 100644
--- a/tests/include/minunit.h
+++ b/tests/include/minunit.h
@@ -1,3 +1,16 @@
+/**
+ * @file minunit.h
+ * @brief Minimal unit testing framework for C
+ * @author Zed Shaw
+ *
+ * @details
+ * This unit testing framework comes from Zed Shaw's book Learn C The Hard
+ * Way, and are evolved from the "minunit" code snippets by Jera Design. I've
+ * added a mu_test_missing() macro to deal with missing unit tests.
+ *
+ * @sa dbg.h
+ */
+
#undef NDEBUG
#ifndef _minunit_h
#define _minunit_h