Changeset 4610 for trunk/psLib/src/sys/psTrace.h

Timestamp:

Jul 25, 2005, 2:44:45 PM (21 years ago)

Author:

drobbin

Message:

made some doxygen comments and formatting updates

File:

• trunk/psLib/src/sys/psTrace.h (modified) (5 diffs)

trunk/psLib/src/sys/psTrace.h

@@ -9 +9 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.34 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-28 20:17:52 $
+ *  @version $Revision: 1.35 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-07-26 00:44:44 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -51 +51 @@
         typedef struct p_psComponent
         {
-            const char *name;   // last part of name of component
-            psS32 level;   // trace level for this component
-            bool p_psSpecified;
-            psS32 n;    // number of subcomponents
-            struct p_psComponent* *subcomp;     // next level of subcomponents
+            const char *name;                  ///< last part of name of component
+            psS32 level;                       ///< trace level for this component
+            bool p_psSpecified;                ///< whether the component is specified
+            psS32 n;                           ///< number of subcomponents
+            struct p_psComponent* *subcomp;    ///< next level of subcomponents
         }
 p_psComponent;
 
+/** Sends a trace message. */
 #ifdef DOXYGEN
 void psTrace(
@@ -80 +81 @@
 #endif /* DOXYGEN */
 
-/// Set trace level
+/** Set trace level
+ *
+ *  @return psBool:       True if successful, otherwise false
+ */
 psBool psTraceSetLevel(
     const char *facil,                 ///< facilty of interest
@@ -86 +90 @@
 );
 
-/// Get the trace level
+/** Get the trace level
+ *
+ *  @return int:    Trace Level
+ */
 int psTraceGetLevel(
     const char *facil                  ///< facilty of interest
@@ -99 +106 @@
 /// Set the destination of future trace messages.
 void psTraceSetDestination(
-    FILE * fp                          ///<
+    FILE * fp                          ///< Pointer to file
 );
 
-/// Get the current destination for trace messages.
+/** Get the current destination for trace messages.
+ *
+ *  @return FILE*:      File Destination
+ */
 FILE *psTraceGetDestination(void);