Revision: 77011
http://sourceforge.net/p/brlcad/code/77011
Author: starseeker
Date: 2020-09-01 12:41:57 +0000 (Tue, 01 Sep 2020)
Log Message:
-----------
Add some doxygen adjustments.
Modified Paths:
--------------
brlcad/trunk/include/bu/app.h
brlcad/trunk/include/bu/glob.h
brlcad/trunk/include/bu/interrupt.h
brlcad/trunk/include/bu/mime.h
brlcad/trunk/misc/doxygen/libbu.dox
Modified: brlcad/trunk/include/bu/app.h
===================================================================
--- brlcad/trunk/include/bu/app.h 2020-09-01 07:21:39 UTC (rev 77010)
+++ brlcad/trunk/include/bu/app.h 2020-09-01 12:41:57 UTC (rev 77011)
@@ -38,8 +38,8 @@
*
*/
/** @{ */
+/** @file bu/app.h */
-
/**
* DEPRECATED: This routine is replaced by bu_getcwd().
* Do not use.
Modified: brlcad/trunk/include/bu/glob.h
===================================================================
--- brlcad/trunk/include/bu/glob.h 2020-09-01 07:21:39 UTC (rev 77010)
+++ brlcad/trunk/include/bu/glob.h 2020-09-01 12:41:57 UTC (rev 77011)
@@ -29,7 +29,7 @@
__BEGIN_DECLS
-/** @addtogroup bu_glob
+/** @addtogroup bu_experimental
*
* NOTE - the glob API below is a work in progress - until this notice is
* removed it should not be considered functional, much less stable!
Modified: brlcad/trunk/include/bu/interrupt.h
===================================================================
--- brlcad/trunk/include/bu/interrupt.h 2020-09-01 07:21:39 UTC (rev 77010)
+++ brlcad/trunk/include/bu/interrupt.h 2020-09-01 12:41:57 UTC (rev 77011)
@@ -28,7 +28,7 @@
__BEGIN_DECLS
-/** @addtogroup bu_interrupt
+/** @addtogroup bu_env
*
* @brief Routines for managing signals.
*
Modified: brlcad/trunk/include/bu/mime.h
===================================================================
--- brlcad/trunk/include/bu/mime.h 2020-09-01 07:21:39 UTC (rev 77010)
+++ brlcad/trunk/include/bu/mime.h 2020-09-01 12:41:57 UTC (rev 77011)
@@ -29,11 +29,10 @@
__BEGIN_DECLS
-
-/**
- * @addtogroup bu_mime
+/** @addtogroup bu_mime
*
- * @brief Functions generated by the mime.cmake script - see the
+ * @brief
+ * Functions generated by the mime.cmake script - see the
* generated files mime.c and mime_types.h for the resulting C code
* and mime type declarations
*
@@ -46,11 +45,11 @@
* the majority of geometry formats) are added there instead of
* changing mime.types.
*/
-/** { */
+/** @{ */
+/** @file bu/mime.h */
-
/**
- * Use the file extension to attempt to determine the media type
+ * @brief Use the file extension to attempt to determine the media type
* of the file within the specified context.
*
* returns -1 if no match was found, or an integer if a result
@@ -61,7 +60,7 @@
/**
- * Given a mime type and a context, return the file extension(s)
+ * @brief Given a mime type and a context, return the file extension(s)
* associated with that type.
*
* returns NULL if no match was found, or a comma separated string
@@ -72,7 +71,7 @@
/**
- * Given a mime type and a context, return a human readable string
+ * @brief Given a mime type and a context, return a human readable string
* spelling out the type (corresponding to the enum string in
* source code.)
*
@@ -83,7 +82,7 @@
/**
- * Given a string produced by bu_file_mime_str, convert it back into
+ * @brief Given a string produced by bu_file_mime_str, convert it back into
* integer form.
*
* returns -1 if no match was found, or an integer if a result
Modified: brlcad/trunk/misc/doxygen/libbu.dox
===================================================================
--- brlcad/trunk/misc/doxygen/libbu.dox 2020-09-01 07:21:39 UTC (rev 77010)
+++ brlcad/trunk/misc/doxygen/libbu.dox 2020-09-01 12:41:57 UTC (rev 77011)
@@ -6,11 +6,21 @@
/** @defgroup bu_defines Definitions*/
/** @ingroup libbu */
+/** @defgroup bu_app Applications */
+/** @addtogroup bu_app
+ @brief Routines for application setup and supplying information to user
programs.
+ */
+/** @ingroup libbu */
/** @defgroup bu_container Data Containers */
/** @addtogroup bu_container
@brief Containers for holding various kinds of information.
*/
/** @ingroup libbu */
+/** @defgroup bu_dylib Dynamic Libraries*/
+/** @addtogroup bu_dylib
+ @brief Wrap platform-specific functionality for managing dynamic library
run-time loading, symbol access and unloading.
+ */
+/** @ingroup libbu */
/** @defgroup bu_memory Memory Management */
/** @addtogroup bu_memory
@brief Wrappers for memory allocation and release, and mapping.
@@ -50,6 +60,12 @@
/** @ingroup libbu */
/** @defgroup bu_version Version */
+/** @ingroup libbu */
+/** @defgroup bu_experimental EXPERIMENTAL */
+/** @addtogroup bu_experimental
+ @brief In-progress API, not ready for general use.
+ */
+
/* Data Containers */
/** @ingroup bu_container */
/** @defgroup bu_avs Attribute/Value Sets */
@@ -96,6 +112,8 @@
/** @ingroup bu_io */
/** @defgroup bu_log Logging */
/** @ingroup bu_io */
+/** @defgroup bu_tbl Tabular Printing */
+/** @ingroup bu_io */
/** @defgroup bu_observer Observer*/
/** @ingroup bu_io */
/** @defgroup bu_vfont Vector Fonts */
@@ -106,6 +124,8 @@
/** @ingroup bu_data */
/** @defgroup bu_conv Data Conversion */
/** @ingroup bu_data */
+/** @defgroup bu_mime Mime Types */
+/** @ingroup bu_data */
/** @defgroup bu_hist Histogram Handling */
/** @ingroup bu_data */
/** @defgroup bu_sort Sorting Algorithms */
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
