Changeset 518 for vtcross/trunk/src/include/vtcross/error.h

Timestamp:

11/13/09 15:37:02 (14 years ago)

Author:

bhilburn

Message:

Added Doxygen documentation to headers in the include/vtcross directory.

Files:

• vtcross/trunk/src/include/vtcross/error.h (modified) (1 diff)

vtcross/trunk/src/include/vtcross/error.h

@@ -15 +15 @@
 */
 
-/* DESCRIPTION OF FILE.
+/*! This header defines macros for printing to standard error out.  The macros
+ * in this file should be used rather than printing to stderr with fprintf or
+ * exiting with a hard-coded 'exit' call.
  */