From 664a331115f3f385d7136745d0b4dd420946929f Mon Sep 17 00:00:00 2001
From: Gertjan van den Burg <burg@ese.eur.nl>
Date: Thu, 6 Oct 2016 19:14:58 +0200
Subject: documentation fixes

---
 include/gensvm_optimize.h |  2 +-
 src/GenSVMgrid.c          |  2 +-
 src/gensvm_gridsearch.c   |  2 +-
 tests/include/dbg.h       | 12 ++++++++++++
 tests/include/minunit.h   | 13 +++++++++++++
 5 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/include/gensvm_optimize.h b/include/gensvm_optimize.h
index dec8914..b342d6b 100644
--- a/include/gensvm_optimize.h
+++ b/include/gensvm_optimize.h
@@ -1,5 +1,5 @@
 /**
- * @file gensvm_train.h
+ * @file gensvm_optimize.h
  * @author Gertjan van den Burg
  * @date August, 2013
  * @brief Header file for gensvm_train.c
diff --git a/src/GenSVMgrid.c b/src/GenSVMgrid.c
index 2ac9ce3..3aa1f5c 100644
--- a/src/GenSVMgrid.c
+++ b/src/GenSVMgrid.c
@@ -1,5 +1,5 @@
 /**
- * @file GenSVM_grid.c
+ * @file GenSVMgrid.c
  * @author Gertjan van den Burg
  * @date January, 2014
  * @brief Command line interface for the grid search program
diff --git a/src/gensvm_gridsearch.c b/src/gensvm_gridsearch.c
index a79c31e..0368731 100644
--- a/src/gensvm_gridsearch.c
+++ b/src/gensvm_gridsearch.c
@@ -1,5 +1,5 @@
 /**
- * @file gensvm_train_dataset.c
+ * @file gensvm_gridsearch.c
  * @author Gertjan van den Burg
  * @date January, 2014
  * @brief Functions for finding the optimal parameters for the dataset
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
-- 
cgit v1.2.3