Merge branch 'master' of github:/szmoore/MCTX3420

[matches/MCTX3420.git] / server / options.h

diff --git a/server/options.h b/server/options.h
index 66cad6c..0416dd5 100644 (file)
--- a/server/options.h
+++ b/server/options.h
@@ -1,18 +1,30 @@
 /**
  * @file options.h
- * @purpose Declaration of structure to handle options passed to program
+ * @brief Define the Options structure and the g_options variable
  */
 
 #ifndef _OPTIONS_H
 #define _OPTIONS_H
 
+
+/** Store options passed or calculated from arguments to the program **/
 typedef struct
 {
-       const char * program; //name of program
-       int verbosity; // verbosity level
+       /** Name of program **/
+       const char * program;
+       /** Determines at what level log messages are shown **/
+       int verbosity;
+       /** Time at which program begins to run **/
+       struct timeval start_time;
+       /** Time at which program exits **/
+       struct timeval end_time;
+
+       /** Path to ADC files **/
+       char * adc_device_path;
 
 } Options;
 
-extern Options g_options; // global options structure
+/** The only instance of the Options struct **/
+extern Options g_options;
 
 #endif //_OPTIONS_H