aboutsummaryrefslogtreecommitdiff
path: root/include/libMSVMMaj.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libMSVMMaj.h')
-rw-r--r--include/libMSVMMaj.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/include/libMSVMMaj.h b/include/libMSVMMaj.h
index 21efc2f..b7261dc 100644
--- a/include/libMSVMMaj.h
+++ b/include/libMSVMMaj.h
@@ -1,3 +1,20 @@
+/**
+ * @file libMSVMMaj.h
+ * @author Gertjan van den Burg
+ * @date August, 2013
+ * @brief Header file for the core MSVMMaj library libMSVMMaj.c
+ *
+ * @details
+ * The core computational routines for MSVMMaj are defined in libMSVMMaj.c.
+ * This file contains function declarations for these functions.
+ *
+ */
+
+/**
+ * @todo
+ * rename this file and libMSVMMaj.c to correspond with the lowercase convention.
+ * Also change the name of the include guard.
+ */
#ifndef LIBMSVMMAJ_H
#define LIBMSVMMAJ_H