X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/e83d0967d4c0965eb8036248acc20d1bf12ad1d8..deaaa1150bb34cab211262b7079eb3ccf5697a87:/lib/defs.c

diff --git a/lib/defs.c b/lib/defs.c
index 7a11ebd..c9668c0 100644
--- a/lib/defs.c
+++ b/lib/defs.c
@@ -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,15 +29,36 @@
 #include "defs.h"
 #include "definitions.h"
 
+/** @brief Software version number */
 const char disorder_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;
 
+/** @brief Package documentation directory */
+const char docdir[] = DOCDIR;
+
 /*
 Local Variables:
 c-basic-offset:2