git.ucc.asn.au
/
matches
/
MCTX3420.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
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
..
297acf4
100644
(file)
--- a/
server/options.h
+++ b/
server/options.h
@@
-1,18
+1,23
@@
/**
* @file options.h
/**
* @file options.h
- * @purpose De
claration of structure to handle options passed to program
+ * @purpose De
fine the Options structure and the g_options variable
*/
#ifndef _OPTIONS_H
#define _OPTIONS_H
*/
#ifndef _OPTIONS_H
#define _OPTIONS_H
+
+/** Store options passed or calculated from arguments to the program **/
typedef struct
{
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;
} Options;
} Options;
-extern Options g_options; // global options structure
+/** The only instance of the Options struct **/
+extern Options g_options;
#endif //_OPTIONS_H
#endif //_OPTIONS_H
UCC
git Repository :: git.ucc.asn.au