aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorGertjan van den Burg <burg@ese.eur.nl>2016-10-14 19:00:33 +0200
committerGertjan van den Burg <burg@ese.eur.nl>2016-10-14 19:00:33 +0200
commit0cc025358af341b7e9757e2b9ce5eb0b09af7b2f (patch)
tree343f50cdba91361ddd0a18c554a7cd646d88aff8 /include
parentadd sparse matrices to GenSVM and reorganize update functionality (diff)
downloadgensvm-0cc025358af341b7e9757e2b9ce5eb0b09af7b2f.tar.gz
gensvm-0cc025358af341b7e9757e2b9ce5eb0b09af7b2f.zip
documentation fixes
Diffstat (limited to 'include')
-rw-r--r--include/gensvm_debug.h2
-rw-r--r--include/gensvm_globals.h2
-rw-r--r--include/gensvm_grid.h2
-rw-r--r--include/gensvm_io.h2
-rw-r--r--include/gensvm_kernel.h2
-rw-r--r--include/gensvm_matrix.h16
-rw-r--r--include/gensvm_memory.h5
-rw-r--r--include/gensvm_task.h2
-rw-r--r--include/gensvm_timer.h4
9 files changed, 12 insertions, 25 deletions
diff --git a/include/gensvm_debug.h b/include/gensvm_debug.h
index d95d0eb..361e885 100644
--- a/include/gensvm_debug.h
+++ b/include/gensvm_debug.h
@@ -3,7 +3,7 @@
* @file gensvm_debug.h
* @author Gertjan van den Burg
* @date May, 2016
- * @brief Header for useful debug functions
+ * @brief Header file for gensvm_debug.c
*
* @details
* Contains defines useful for debugging.
diff --git a/include/gensvm_globals.h b/include/gensvm_globals.h
index 96d3b38..74aafd2 100644
--- a/include/gensvm_globals.h
+++ b/include/gensvm_globals.h
@@ -1,5 +1,5 @@
/**
- * @file globals.h
+ * @file gensvm_globals.h
* @author Gertjan van den Burg
* @date January, 2014
* @brief Global definitions
diff --git a/include/gensvm_grid.h b/include/gensvm_grid.h
index a37ce12..d01aa9c 100644
--- a/include/gensvm_grid.h
+++ b/include/gensvm_grid.h
@@ -2,7 +2,7 @@
* @file gensvm_grid.h
* @author Gertjan van den Burg
* @date May, 2016
- * @brief Structs necessary for the grid search
+ * @brief Header file for gensvm_grid.c
*
* @details
* The grid search for the optimal parameters is done through a queue.
diff --git a/include/gensvm_io.h b/include/gensvm_io.h
index 3f34c1a..6ba14f4 100644
--- a/include/gensvm_io.h
+++ b/include/gensvm_io.h
@@ -2,7 +2,7 @@
* @file gensvm_io.h
* @author Gertjan van den Burg
* @date January, 2014
- * @brief Header files for gensvm_io.c
+ * @brief Header file for gensvm_io.c
*
* @details
* Function declarations for input/output functions.
diff --git a/include/gensvm_kernel.h b/include/gensvm_kernel.h
index a1fac20..b832eb9 100644
--- a/include/gensvm_kernel.h
+++ b/include/gensvm_kernel.h
@@ -2,7 +2,7 @@
* @file gensvm_kernel.h
* @author Gertjan van den Burg
* @date January, 2014
- * @brief Header file for kernel functionality
+ * @brief Header file for gensvm_kernel.c
*
* @details
* Contains function declarations for computing the kernel matrix
diff --git a/include/gensvm_matrix.h b/include/gensvm_matrix.h
deleted file mode 100644
index 9982b78..0000000
--- a/include/gensvm_matrix.h
+++ /dev/null
@@ -1,16 +0,0 @@
-/**
- * @file gensvm_matrix.h
- * @author Gertjan van den Burg
- * @date August, 2013
- * @brief Header with defines for matrix access
- *
- * @details
- * Contains defines useful for dealing with matrices.
- *
- */
-
-#ifndef GENSVM_MATRIX_H
-#define GENSVM_MATRIX_H
-
-
-#endif
diff --git a/include/gensvm_memory.h b/include/gensvm_memory.h
index 08d6f2d..3af95d1 100644
--- a/include/gensvm_memory.h
+++ b/include/gensvm_memory.h
@@ -2,7 +2,10 @@
* @file gensvm_memory.h
* @author Gertjan van den Burg
* @date May, 2016
- * @brief Global definitions
+ * @brief Header file for gensvm_memory.c
+ *
+ * @details
+ * Contains macro definitions for easy memory access.
*
*/
diff --git a/include/gensvm_task.h b/include/gensvm_task.h
index 98c8f26..16ab361 100644
--- a/include/gensvm_task.h
+++ b/include/gensvm_task.h
@@ -2,7 +2,7 @@
* @file gensvm_task.h
* @author Gertjan van den Burg
* @date August, 2013
- * @brief Struct for a single task in the queue
+ * @brief Header file for gensvm_task.c
*
* @details
* The grid search for the optimal parameters is done through a queue.
diff --git a/include/gensvm_timer.h b/include/gensvm_timer.h
index 5dd4dcb..4c541b3 100644
--- a/include/gensvm_timer.h
+++ b/include/gensvm_timer.h
@@ -1,8 +1,8 @@
/**
- * @file timer.h
+ * @file gensvm_timer.h
* @author Gertjan van den Burg
* @date August, 2013
- * @brief Header file for timer.c
+ * @brief Header file for gensvm_timer.c
*
* @details
* Function declaration for timer function used to measure computation time.