Revision: 57204
http://sourceforge.net/p/brlcad/code/57204
Author: brlcad
Date: 2013-08-28 03:31:56 +0000 (Wed, 28 Aug 2013)
Log Message:
-----------
make it clear that the arg is the result, doxygen comment shouldn't be @file so
it gets associated with the function that follows (@file only useful for
multi-function source files that warrant an intro on the package they belong
with.
Modified Paths:
--------------
brlcad/trunk/include/bu.h
Modified: brlcad/trunk/include/bu.h
===================================================================
--- brlcad/trunk/include/bu.h 2013-08-28 03:31:25 UTC (rev 57203)
+++ brlcad/trunk/include/bu.h 2013-08-28 03:31:56 UTC (rev 57204)
@@ -1946,7 +1946,7 @@
/**
*
*/
-struct bu_vls {
+struct bu_vls {
uint32_t vls_magic;
char *vls_str; /**< Dynamic memory for buffer */
size_t vls_offset; /**< Offset into vls_str where data is good */
@@ -6191,11 +6191,14 @@
/** @addtogroup file */
/** @ingroup io */
/** @{ */
-/** @file libbu/date-time.c
- * Put the current UTC time in ISO format into the user-provided
- * bu_vls struct.
+/**
+ * Evaluate the current UTC time in ISO format as a string.
+ *
+ * The UTC time is written into the user-provided bu_vls struct. and is
+ * also returned and guaranteed to be a non-null result, returning a
+ * static "NULL" UTC time if an error is encountered.
*/
-BU_EXPORT void bu_utctime(struct bu_vls *vls_gmtime);
+BU_EXPORT void bu_utctime(struct bu_vls *utc_result);
/** @} */
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more!
Discover the easy way to master current and previous Microsoft technologies
and advance your career. Get an incredible 1,500+ hours of step-by-step
tutorial videos with LearnDevNow. Subscribe today and save!
http://pubads.g.doubleclick.net/gampad/clk?id=58040911&iu=/4140/ostg.clktrk
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
