Revision: 54409
http://brlcad.svn.sourceforge.net/brlcad/?rev=54409&view=rev
Author: brlcad
Date: 2013-02-14 18:59:43 +0000 (Thu, 14 Feb 2013)
Log Message:
-----------
document the structparse API a little better, note the flow of data since the
API is inconsistent.
Modified Paths:
--------------
brlcad/trunk/include/bu.h
Modified: brlcad/trunk/include/bu.h
===================================================================
--- brlcad/trunk/include/bu.h 2013-02-14 18:25:08 UTC (rev 54408)
+++ brlcad/trunk/include/bu.h 2013-02-14 18:59:43 UTC (rev 54409)
@@ -4115,22 +4115,41 @@
* offset from the beginning of the structure, and a pointer to an
* optional "hooked" function that is called whenever that structure
* element is changed.
+ */
+
+/**
+ * ASCII to struct elements.
*
- * @par There are four basic operations supported:
- * @arg print struct elements to ASCII
- * @arg parse ASCII to struct elements
- * @arg export struct elements to machine-independent binary
- * @arg import machine-independent binary to struct elements
+ * Parse the structure element description in the vls string "vls"
+ * according to the structure description in "parsetab"
*
+ * @return <0 failure
+ * @return 0 OK
*/
+BU_EXPORT extern int bu_struct_parse(const struct bu_vls *in_vls,
+ const struct bu_structparse *desc,
+ const char *base);
/**
+ * struct elements to ASCII.
*/
+BU_EXPORT extern void bu_struct_print(const char *title,
+ const struct bu_structparse *parsetab,
+ const char *base);
+
+/**
+ * struct elements to machine-independent binary.
+ *
+ * copies ext data to base
+ */
BU_EXPORT extern int bu_struct_export(struct bu_external *ext,
const genptr_t base,
const struct bu_structparse *imp);
/**
+ * machine-independent binary to struct elements.
+ *
+ * copies ext data to base
*/
BU_EXPORT extern int bu_struct_import(genptr_t base,
const struct bu_structparse *imp,
@@ -4166,23 +4185,6 @@
genptr_t buf);
/**
- * Parse the structure element description in the vls string "vls"
- * according to the structure description in "parsetab"
- *
- * @return <0 failure
- * @return 0 OK
- */
-BU_EXPORT extern int bu_struct_parse(const struct bu_vls *in_vls,
- const struct bu_structparse *desc,
- const char *base);
-
-/**
- */
-BU_EXPORT extern void bu_struct_print(const char *title,
- const struct bu_structparse *parsetab,
- const char *base);
-
-/**
* This differs from bu_struct_print in that this output is less
* readable by humans, but easier to parse with the computer.
*/
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Free Next-Gen Firewall Hardware Offer
Buy your Sophos next-gen firewall before the end March 2013
and get the hardware for free! Learn more.
http://p.sf.net/sfu/sophos-d2d-feb
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
