Revision: 55625
http://sourceforge.net/p/brlcad/code/55625
Author: brlcad
Date: 2013-06-01 03:35:34 +0000 (Sat, 01 Jun 2013)
Log Message:
-----------
clean up api documentation on bu_vls_vprintf() and bu_vls_printf()
Modified Paths:
--------------
brlcad/trunk/include/bu.h
Modified: brlcad/trunk/include/bu.h
===================================================================
--- brlcad/trunk/include/bu.h 2013-06-01 03:25:26 UTC (rev 55624)
+++ brlcad/trunk/include/bu.h 2013-06-01 03:35:34 UTC (rev 55625)
@@ -5087,23 +5087,31 @@
/**
- * Format a string into a vls. This version should work on
- * practically any machine, but it serves to highlight the
- * grossness of the varargs package requiring the size of a parameter
- * to be known at compile time.
+ * Format a string into a vls using a varargs list.
*
- * %s continues to be a regular 'C' string, null terminated.
- * %V is a pointer to a (struct bu_vls *) string.
+ * %s continues to be a regular null-terminated 'C' string (char *).
+ * %V is a libbu variable-length string (struct bu_vls *).
*
+ * Other format specifiers should behave identical to printf().
+ *
* This routine appends to the given vls similar to how vprintf
- * appends to stdout (see bu_vls_printf for overwriting the vls).
+ * appends to stdout (see bu_vls_sprintf for overwriting the vls).
*/
BU_EXPORT extern void bu_vls_vprintf(struct bu_vls *vls,
const char *fmt,
va_list ap);
/**
- * Initializes the va_list, then calls the above bu_vls_vprintf.
+ * Format a string into a vls using standard variable arguments.
+ *
+ * %s continues to be a regular null-terminated 'C' string (char *).
+ * %V is a libbu variable-length string (struct bu_vls *).
+ *
+ * Other format specifiers should behave identical to printf().
+ *
+ * This routine appends to the given vls similar to how vprintf
+ * appends to stdout (see bu_vls_sprintf for overwriting the vls).
+ * The implementation ends up calling bu_vls_vprintf().
*/
BU_EXPORT extern void bu_vls_printf(struct bu_vls *vls,
const char *fmt, ...) _BU_ATTR_PRINTF23;
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Get 100% visibility into Java/.NET code with AppDynamics Lite
It's a free troubleshooting tool designed for production
Get down to code-level detail for bottlenecks, with <2% overhead.
Download for free and get started troubleshooting in minutes.
http://p.sf.net/sfu/appdyn_d2d_ap2
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
