Revision: 77014
http://sourceforge.net/p/brlcad/code/77014
Author: starseeker
Date: 2020-09-01 13:49:46 +0000 (Tue, 01 Sep 2020)
Log Message:
-----------
More doxygen adjustments
Modified Paths:
--------------
brlcad/trunk/include/ged/commands.h
brlcad/trunk/include/ged.h
brlcad/trunk/include/rt/geom.h
brlcad/trunk/include/rt/primitives/annot.h
brlcad/trunk/misc/doxygen/libged.dox
Modified: brlcad/trunk/include/ged/commands.h
===================================================================
--- brlcad/trunk/include/ged/commands.h 2020-09-01 13:27:07 UTC (rev 77013)
+++ brlcad/trunk/include/ged/commands.h 2020-09-01 13:49:46 UTC (rev 77014)
@@ -17,7 +17,7 @@
* License along with this file; see the file named COPYING for more
* information.
*/
-/** @addtogroup ged_commands
+/** @addtogroup libged
*
* Geometry EDiting Library Commands
*
@@ -24,6 +24,7 @@
*/
/** @{ */
/** @file ged/commands.h */
+/** @} */
#ifndef GED_COMMANDS_H
#define GED_COMMANDS_H
@@ -34,9 +35,14 @@
__BEGIN_DECLS
-/* Execute plugin based command */
+/** @addtogroup ged_plugins */
+/** @{ */
+/** Execute plugin based command */
GED_EXPORT extern int ged_exec(struct ged *gedp, int argc, const char *argv[]);
+/** @} */
+/** @addtogroup ged_objects */
+/** @{ */
/**
* Adjust object's attribute(s)
*/
@@ -43,7 +49,8 @@
GED_EXPORT extern int ged_adjust(struct ged *gedp, int argc, const char
*argv[]);
/**
- * Set, get, show, remove or append to attribute values for the specified
object.
+ * @brief Set, get, show, remove or append to attribute values for the
specified object.
+ *
* The arguments for "set" and "append" subcommands are attribute name/value
pairs.
* The arguments for "get", "rm", and "show" subcommands are attribute names.
* The "set" subcommand sets the specified attributes for the object.
@@ -285,7 +292,8 @@
/**
- * Manipulate opaque binary objects.
+ * @brief Manipulate opaque binary objects.
+ *
* Must specify one of -i (for creating or adjusting objects (input))
* or -o for extracting objects (output).
* If the major type is "u" the minor type must be one of:
@@ -818,7 +826,9 @@
*/
GED_EXPORT int ged_pnts(struct ged *gedp, int argc, const char *argv[]);
+/** @} */
+
__END_DECLS
Modified: brlcad/trunk/include/ged.h
===================================================================
--- brlcad/trunk/include/ged.h 2020-09-01 13:27:07 UTC (rev 77013)
+++ brlcad/trunk/include/ged.h 2020-09-01 13:49:46 UTC (rev 77014)
@@ -63,6 +63,9 @@
__BEGIN_DECLS
+/** @addtogroup ged_misc */
+/** @{ */
+
/**
* Delay the specified amount of time
*/
@@ -83,6 +86,7 @@
*/
GED_EXPORT extern int ged_help(struct ged *gedp, int argc, const char *argv[]);
+/** @} */
/***************************************
* Conceptual Documentation for LIBGED *
Modified: brlcad/trunk/include/rt/geom.h
===================================================================
--- brlcad/trunk/include/rt/geom.h 2020-09-01 13:27:07 UTC (rev 77013)
+++ brlcad/trunk/include/rt/geom.h 2020-09-01 13:49:46 UTC (rev 77014)
@@ -954,7 +954,7 @@
#define RT_PNTS_CK_MAGIC(_p) BU_CKMAG(_p, RT_PNTS_INTERNAL_MAGIC,
"rt_pnts_internal")
/** @} */
-/** @addtogroup rt_anno */
+/** @addtogroup rt_annotation */
/** @{ */
/*
* ID_ANNO
Modified: brlcad/trunk/include/rt/primitives/annot.h
===================================================================
--- brlcad/trunk/include/rt/primitives/annot.h 2020-09-01 13:27:07 UTC (rev
77013)
+++ brlcad/trunk/include/rt/primitives/annot.h 2020-09-01 13:49:46 UTC (rev
77014)
@@ -17,7 +17,7 @@
* License along with this file; see the file named COPYING for more
* information.
*/
-/** @addtogroup rt_annot */
+/** @addtogroup rt_annotation */
/** @{ */
/** @file rt/primitives/annot.h */
Modified: brlcad/trunk/misc/doxygen/libged.dox
===================================================================
--- brlcad/trunk/misc/doxygen/libged.dox 2020-09-01 13:27:07 UTC (rev
77013)
+++ brlcad/trunk/misc/doxygen/libged.dox 2020-09-01 13:49:46 UTC (rev
77014)
@@ -5,6 +5,8 @@
/** @ingroup libged */
/** @defgroup ged_defines Definitions*/
/** @ingroup libged */
+/** @defgroup ged_plugins Plugins */
+/** @ingroup libged */
/** @defgroup ged_database Database*/
/** @ingroup libged */
/** @defgroup ged_objects Database Objects*/
@@ -18,6 +20,8 @@
/** @defgroup ged_debug Debugging */
/** @ingroup libged */
/** @defgroup ged_raytrace Raytracing */
+/** @ingroup libged */
+/** @defgroup ged_misc Miscellaneous */
/* Third tier groups */
/** @ingroup ged_view */
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
