Revision: 65300
http://sourceforge.net/p/brlcad/code/65300
Author: starseeker
Date: 2015-06-15 14:13:47 +0000 (Mon, 15 Jun 2015)
Log Message:
-----------
Figure out how to add example help printouts to doxygen
Modified Paths:
--------------
brlcad/trunk/include/bu/opt.h
Modified: brlcad/trunk/include/bu/opt.h
===================================================================
--- brlcad/trunk/include/bu/opt.h 2015-06-15 14:00:37 UTC (rev 65299)
+++ brlcad/trunk/include/bu/opt.h 2015-06-15 14:13:47 UTC (rev 65300)
@@ -203,6 +203,17 @@
int description_columns;
};
+/**
+ *
+ * Using the example definition above, bu_opt_describe would
+ * generate the following help string by default:
+ *
+\verbatim
+ -h, --help Print help string and exit.
+ -n #, --num # Read int
+ -f #, --fastf_t # Read float
+\endverbatim
+ */
BU_EXPORT extern const char *bu_opt_describe(struct bu_opt_desc *ds, struct
bu_opt_desc_opts *settings);
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
