Bring CGI docs pretty much up to date

[disorder] / lib / defs.c

diff --git a/lib/defs.c b/lib/defs.c
index 5e3795f997e0810522670e497312af2a81b1cd85..b5e1eff92e1ce045646b06fd343677a2f27b9c77 100644 (file)
--- a/lib/defs.c
+++ b/lib/defs.c
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder
- * Copyright (C) 2005 Richard Kettlewell
+ * Copyright (C) 2005, 2007, 2008 Richard Kettlewell
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,6 +17,11 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file lib/defs.c @brief Definitions chosen by configure
+ *
+ * The binary directories are included so that they can be appended to the path
+ * (see fix_path()), not so that the path can be ignored.
+ */
 
 #include <config.h>
 #include "types.h"
@@ -24,12 +29,35 @@
 #include "defs.h"
 #include "definitions.h"
 
-const char disorder_version_string[] = VERSION;
+/** @brief Software version number */
+const char disorder_short_version_string[] = VERSION;
+
+/** @brief Package library directory */
 const char pkglibdir[] = PKGLIBDIR;
+
+/** @brief Package configuration directory */
 const char pkgconfdir[] = PKGCONFDIR;
+
+/** @brief Package variable state directory */
 const char pkgstatedir[] = PKGSTATEDIR;
+
+/** @brief Package fixed data directory */
 const char pkgdatadir[] = PKGDATADIR;
 
+/** @brief Binary directory */
+const char bindir[] = BINDIR;
+
+/** @brief System binary directory */
+const char sbindir[] = SBINDIR;
+
+/** @brief Fink binary directory
+ *
+ * Meaningless if not on a Mac.
+ */
+const char finkbindir[] = FINKBINDIR;
+
+#include "versionstring.h"
+
 /*
 Local Variables:
 c-basic-offset:2