Changeset 247 for trunk/archive/pslib/include/psTrace.h

Timestamp:

Mar 15, 2004, 3:20:03 PM (22 years ago)

Author:

eugene

Message:

added Doxygen \file and \defgroup entries
some basic reorganization

File:

• trunk/archive/pslib/include/psTrace.h (modified) (2 diffs)

trunk/archive/pslib/include/psTrace.h

@@ -2 +2 @@
 #define PS_TRACE_H 1
 
+/** \file psTrace.h
+ *  \brief basic run-time trace facilities
+ *  \ingroup SystemGroup
+ */
+
 //#define PS_NTRACE 1                   //!< to turn off all tracing
+
 #if defined(PS_NTRACE)
 #  define psTrace(facil, level, ...)    /* do nothing */
@@ -11 +17 @@
 
 /** Send a trace message */
-void p_psTrace(const char *facil, int level, ...);
+void p_psTrace(const char *facil,       //!< facilty of interest
+               int level,               //!< desired trace level
+               ...                      //!< trace message arguments 
+);
 
 /** Set trace level */
 int psSetTraceLevel(const char *facil,  //!< facilty of interest
                     int level           //!< desired trace level
-    );
+);
 
 /** Get the trace level */
 int psGetTraceLevel(const char *name    //!< facilty of interest
-    );
+);
 
 /** turn off all tracing, and free trace's allocated memory */