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

Timestamp:

Mar 9, 2004, 5:19:15 PM (22 years ago)

Author:

Paul Price

Message:

Doxygenation of Lupton stuff partially complete. Still need to hack some more to conform everything to coding standards.

File:

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

trunk/archive/pslib/include/psTrace.h

@@ -2 +2 @@
 #define PS_TRACE_H 1
 
-//#define PS_NTRACE 1                   /* to turn off all tracing */
+//#define PS_NTRACE 1                   //!< to turn off all tracing
 #if defined(PS_NTRACE)
-#  define psTrace(facil, level, ...) /* do nothing */
+#  define psTrace(facil, level, ...)    /* do nothing */
 #else
 #  define psTrace(facil, level, ...) \
@@ -10 +10 @@
 #endif
 
+/** Send a trace message */
 void p_psTrace(const char *facil, int level, ...);
 
-int psSetTraceLevel(const char *facil,  // facilty of interest
-                    int level);         // desired trace level
-int psGetTraceLevel(const char *name);  // facilty of interest
+/** Set trace level */
+int psSetTraceLevel(const char *facil,  //!< facilty of interest
+                    int level           //!< desired trace level
+    );
 
-void psTraceReset(void);                // turn off all tracing, and free trace's allocated memory
+/** Get the trace level */
+int psGetTraceLevel(const char *name    //!< facilty of interest
+    );
 
-void psPrintTraceLevels(void);          // print trace levels
+/** turn off all tracing, and free trace's allocated memory */
+void psTraceReset(void);
+
+/** print trace levels */
+void psPrintTraceLevels(void);
 
 #endif