Revision: 77053
http://sourceforge.net/p/brlcad/code/77053
Author: brlcad
Date: 2020-09-04 04:13:26 +0000 (Fri, 04 Sep 2020)
Log Message:
-----------
convert define and enum comments for doxygen
Modified Paths:
--------------
brlcad/trunk/include/bu/app.h
brlcad/trunk/include/bu/glob.h
Modified: brlcad/trunk/include/bu/app.h
===================================================================
--- brlcad/trunk/include/bu/app.h 2020-09-04 04:09:09 UTC (rev 77052)
+++ brlcad/trunk/include/bu/app.h 2020-09-04 04:13:26 UTC (rev 77053)
@@ -228,22 +228,22 @@
typedef enum {
- BU_DIR_CURR=1, /* (unknown) current working directory */
- BU_DIR_INIT, /* (unknown) initial working directory */
- BU_DIR_BIN, /* (read-only) user executables (bin) */
- BU_DIR_LIB, /* (read-only) object libraries (lib) */
- BU_DIR_LIBEXEC, /* (read-only) object libraries (libexec) */
- BU_DIR_INCLUDE, /* (read-only) C/C++ header files (include) */
- BU_DIR_DATA, /* (read-only) data files (share) */
- BU_DIR_DOC, /* (read-only) documentation, (DATA/doc) */
- BU_DIR_MAN, /* (read-only) manual pages, (DATA/man) */
- BU_DIR_TEMP, /* (read/write) temporary files (TEMP) */
- BU_DIR_HOME, /* (read/write) user home directory (HOME) */
- BU_DIR_CACHE, /* (read/write) user cache directory (BU_CACHE_DIR) */
- BU_DIR_CONFIG, /* (read/write) user config directory (HOME/.app) */
- BU_DIR_EXT, /* (n/a) optional executable extension */
- BU_DIR_LIBEXT, /* (n/a) optional library extension */
- BU_DIR_END
+ BU_DIR_CURR=1, /**< (unknown) current working directory */
+ BU_DIR_INIT, /**< (unknown) initial working directory */
+ BU_DIR_BIN, /**< (read-only) user executables (bin) */
+ BU_DIR_LIB, /**< (read-only) object libraries (lib) */
+ BU_DIR_LIBEXEC, /**< (read-only) object libraries (libexec) */
+ BU_DIR_INCLUDE, /**< (read-only) C/C++ header files (include) */
+ BU_DIR_DATA, /**< (read-only) data files (share) */
+ BU_DIR_DOC, /**< (read-only) documentation, (DATA/doc) */
+ BU_DIR_MAN, /**< (read-only) manual pages, (DATA/man) */
+ BU_DIR_TEMP, /**< (read/write) temporary files (TEMP) */
+ BU_DIR_HOME, /**< (read/write) user home directory (HOME) */
+ BU_DIR_CACHE, /**< (read/write) user cache directory (BU_CACHE_DIR) */
+ BU_DIR_CONFIG, /**< (read/write) user config directory (HOME/.app) */
+ BU_DIR_EXT, /**< (n/a) optional executable extension */
+ BU_DIR_LIBEXT, /**< (n/a) optional library extension */
+ BU_DIR_END /**< always the last entry, for iterators */
} bu_dir_t;
Modified: brlcad/trunk/include/bu/glob.h
===================================================================
--- brlcad/trunk/include/bu/glob.h 2020-09-04 04:09:09 UTC (rev 77052)
+++ brlcad/trunk/include/bu/glob.h 2020-09-04 04:13:26 UTC (rev 77053)
@@ -67,10 +67,10 @@
*/
struct bu_glob_context {
-#define BU_GLOB_APPEND 0x0001 /* Append to output from previous call. */
-#define BU_GLOB_NOSORT 0x0020 /* Don't sort. */
-#define BU_GLOB_NOESCAPE 0x2000 /* Disable backslash escaping. */
-#define BU_GLOB_ALTDIRFUNC 0x0040 /* use alternate functions. */
+#define BU_GLOB_APPEND 0x0001 /**< Append to output from previous call. */
+#define BU_GLOB_NOSORT 0x0020 /**< Don't sort. */
+#define BU_GLOB_NOESCAPE 0x2000 /**< Disable backslash escaping. */
+#define BU_GLOB_ALTDIRFUNC 0x0040 /**< use alternate functions. */
int gl_flags; /**< flags customizing globbing behavior */
/* Return values */
@@ -88,8 +88,8 @@
int (*gl_lstat)(const char *, struct bu_stat *, struct bu_glob_context *);
int (*gl_stat)(const char *, struct bu_stat *, struct bu_glob_context *);
-#define BU_GLOB_NOMATCH (-1) /* No match. */
-#define BU_GLOB_ABORTED (-2) /* Unignored error. */
+#define BU_GLOB_NOMATCH (-1) /**< No match. */
+#define BU_GLOB_ABORTED (-2) /**< Unignored error. */
int (*gl_errfunc)(const char *, int, struct bu_glob_context *);
/* For caller use */
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
