Changeset 1013 for trunk/psLib/src/sysUtils/psTrace.h

Timestamp:

Jun 11, 2004, 7:50:01 PM (22 years ago)

Author:

gusciora

Message:

cosmetics...

File:

• trunk/psLib/src/sysUtils/psTrace.h (modified) (4 diffs)

trunk/psLib/src/sysUtils/psTrace.h

@@ +1 @@
+/** @file psTrace.h
+ *  \brief basic run-time trace facilities
+ *  \ingroup LogTrace
+ *
+ *  This file will hold the prototypes for defining procedures to insert
+ *  trace messages into the code.
+ *
+ *  @author Robert Lupton, Princeton University
+ *  @author George Gusciora, MHPCC
+ *
+ *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-06-12 05:50:01 $
+ *
+ *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
+ */
 #if !defined(PS_TRACE_H)
 #define PS_TRACE_H 1
@@ -4 +19 @@
 #define DEFAULT_TRACE_LEVEL 0
 
-/** \file psTrace.h
- *  \brief basic run-time trace facilities
- *  \ingroup LogTrace
- */
-
-/*****************************************************************************
-    A component is a string of the form aaa.bbb.ccc, and may itself contain
-    further subcomponents.  The Component structure doesn't in fact contain
-    it's full name, but only the last part.
- *****************************************************************************/
+/** Basic structure for the component tree.  A component is a string of the
+    form aaa.bbb.ccc, and may itself contain further subcomponents.  The
+    Component structure doesn't in fact contain it's full name, but only the
+    last part. */
 typedef struct Component
 {
@@ -26 +35 @@
  *  \{
  */
-
 
 /** Functions **************************************************************/
@@ -59 +67 @@
 ;
 
+/// Set the destination of future trace messages.
 void psTraceSetDestination(FILE *fp);