Revision: 65277
http://sourceforge.net/p/brlcad/code/65277
Author: starseeker
Date: 2015-06-12 00:54:18 +0000 (Fri, 12 Jun 2015)
Log Message:
-----------
add a couple of comments - once this stables, needs extensive docs and examples.
Modified Paths:
--------------
brlcad/trunk/include/bu/opt.h
Modified: brlcad/trunk/include/bu/opt.h
===================================================================
--- brlcad/trunk/include/bu/opt.h 2015-06-12 00:48:30 UTC (rev 65276)
+++ brlcad/trunk/include/bu/opt.h 2015-06-12 00:54:18 UTC (rev 65277)
@@ -148,6 +148,13 @@
* >0 - some unused argv entries returned at the beginning of the argv array.
* returned int is unused argc count.
*
+ * msgs will collect any informational messages generated by the parser
(typically
+ * used for error reporting.)
+ *
+ * Note: An option definition without an arg_process callback that indicates
+ * the option requires >0 arguments in its definition will be treated as a
+ * fatal error, should that option be encountered while processing an argv
+ * input.
*/
BU_EXPORT extern int bu_opt_parse(struct bu_vls *msgs, int ac, const char
**argv, struct bu_opt_desc *ds);
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
