Changeset 196 for trunk/archive/pslib/include/psLogMsg.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/psLogMsg.h (modified) (1 diff)

trunk/archive/pslib/include/psLogMsg.h

@@ -3 +3 @@
 #include <stdarg.h>
 
-enum { PS_LOG_ABORT = 0, PS_LOG_ERROR, PS_LOG_WARN, PS_LOG_INFO };
+enum { PS_LOG_ABORT = 0, PS_LOG_ERROR, PS_LOG_WARN, PS_LOG_INFO }; //!< Status codes for log messages
 
-enum { PS_LOG_TO_STDERR, PS_LOG_TO_STDOUT };
+enum { PS_LOG_TO_STDERR, PS_LOG_TO_STDOUT }; //!< Destinations for log messages
 
-int psSetLogDestination(int dest);
-int psSetLogLevel(int level);
-void psSetLogFormat(const char *fmt);
+int psSetLogDestination(int dest);      //!< Sets the log destination
+int psSetLogLevel(int level);           //!< Sets the log level
+void psSetLogFormat(const char *fmt);   //!< sets the log format
 
-void psLogMsg(const char *name, int level, const char *fmt, ...);
-void p_psVLogMsg(const char *name, int level, const char *fmt, va_list ap);
+void psLogMsg(const char *name, int level, const char *fmt, ...); //!< Logs a message
+void p_psVLogMsg(const char *name, int level, const char *fmt, va_list ap); //!< Logs a message from varargs
 
 #endif