added documentation, restart git usage, start implementing kernels

1 files changed, 30 insertions, 10 deletions

diff --git a/include/types.h b/include/types.h
index b4db8d8..f6d008b 100644
--- a/include/types.h
+++ b/include/types.h
@@ -1,21 +1,41 @@
-#ifndef TYPES_H
-#define TYPES_H
+/**
+ * @file types.h
+ * @author Gertjan van den Burg
+ * @date August, 2013
+ * @brief Definitions of common types
+ *
+ * @details 
+ * Here common types used throughout the program are defined.
+ *
+ */
 
+#ifndef MSVMMAJ_TYPES_H
+#define MSVMMAJ_TYPES_H
+
+/**
+ * @brief Implementation of true and false
+ */
 typedef enum {
-	false,
-	true
+	false=0, /**< false keyword, corresponding to 0. */
+	true=1 /**< true keyword, corresponding to 1. */
 } bool;
 
+/**
+ * @brief type of training used in parameter grid search
+ */
 typedef enum {
-	CV=0,
-	TT=1
+	CV=0, /**< cross validation */
+	TT=1  /**< data with existing train/test split */
 } TrainType;
 
+/**
+ * @brief type of kernel used in training
+ */
 typedef enum {
-	K_LINEAR=0,
-	K_POLY=1,
-	K_RBF=2,
-	K_SIGMOID=3,
+	K_LINEAR=0, 	/**< Linear kernel */
+	K_POLY=1, 	/**< Polynomial kernel */
+	K_RBF=2, 	/**< RBF kernel */
+	K_SIGMOID=3,  	/**< Sigmoid kernel */
 } KernelType;
 
 #endif