Changeset 518 for vtcross/trunk/src/include/vtcross/debug.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/debug.h (modified) (1 diff)

vtcross/trunk/src/include/vtcross/debug.h

@@ -15 +15 @@
 */
 
-/* DESCRIPTION OF FILE.
+/*! This header defines macros for log functions and debug statements.
+ * Generally, it is recommended that this header be included in every source
+ * file.  The functions included in this file should be used rather than
+ * hard-coding 'printf's or 'cout's in your code.
  */