Changeset 1013 for trunk/psLib/src/sys/psLogMsg.h

Timestamp:

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

Author:

gusciora

Message:

cosmetics...

File:

• trunk/psLib/src/sys/psLogMsg.h (modified) (6 diffs)

trunk/psLib/src/sys/psLogMsg.h

@@ +1 @@
+/** @file  psLogMsg.h
+ *  @brief Procedures for logging messages.
+ *  \ingroup LogTrace
+ *
+ *  This file will hold the prototypes for defining procedure which set
+ *  message log levels, messahe log formats, message log destinations, and
+ *  for generating the messages themselves.
+ *  @ingroup LogTrace
+ *
+ *  @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_LOG_MSG_H)
 #define PS_LOG_MSG_H
-
-/** \file psLogMsg.h
- *  \brief log messaging facilities
- *  \ingroup LogTrace
- */
-
 #include <stdarg.h>
 
@@ -18 +29 @@
 /// In future versions, this procedure will take a character string as an
 /// argument which can specify more general log destinations.
-int psLogSetDestination(int dest);
+int psLogSetDestination(int dest     ///< Specifies where to send messages.
+                       );
+
 
 /// This procedure sets the message level for future log messages.  Subsequent
@@ -25 +38 @@
 /// Ie. higher values set by this procedure will cause more log messages to
 /// be displayed.
-int psLogSetLevel(int level);
+int psLogSetLevel(int level          ///< Specifies the system log level
+                 );
+
 
 /// This procedure sets the log format for future log messages.  The argument
@@ -32 +47 @@
 /// Deleting a letter from the string will cause the associated information
 /// to not be logged.
-void psLogSetFormat(const char *fmt);
+void psLogSetFormat(const char *fmt ///< Specifies the system log format
+                   );
 
 
@@ -41 +57 @@
 void psLogMsg(const char *name,     ///< name of the log source
               int myLevel,          ///< severity level of this log message
-              const char *fmt, ...) ///< printf-style format command
-;
-
+              const char *fmt, ...  ///< printf-style format command
+             );
 
 
@@ -51 +66 @@
                int myLevel,      ///< severity level of this log message
                const char *fmt,  ///< printf-style format command
-               va_list ap)       ///< varargs argument list
-;
-
+               va_list ap        ///< varargs argument list
+              );
 
 ///< Status codes for log messages