Changeset 4190 for trunk/psLib/src/sysUtils/psError.h

Timestamp:

Jun 9, 2005, 9:26:48 AM (21 years ago)

Author:

drobbin

Message:

* empty log message *

File:

• trunk/psLib/src/sysUtils/psError.h (modified) (3 diffs)

trunk/psLib/src/sysUtils/psError.h

@@ -12 +12 @@
  *  @author Eric Van Alst, MHPCC
  *
- *  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-08 23:40:45 $
+ *  @version $Revision: 1.22 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-09 19:26:48 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -120 +120 @@
     psErrorCode code,                  ///< Error class code
     psBool new,                        ///< true if error originates at this location
-    const char* fmt,
-    ...
+    const char* fmt,                   ///< printf-style format of header line
+    ...                                ///< any parameters required in fmt
 );
 
@@ -132 +132 @@
  */
 void psWarning(
-    const char* fmt,
-    ...
+    const char* fmt,                   ///< printf-style format of header line
+    ...                                ///< any parameters required in fmt
 );
 #else // #ifdef DOXYGEN
+
+/** Reports an error message to the logging facility
+ *  
+ *  This function will invoke the psLogMsg function with a level of
+ *  PS_LOG_ERROR and pass the parameters name and fmt to generate a proper
+ *  log message.  This function is used to check a specific code location.
+ *  
+ *  This function modifies the error stack.
+ *
+ *  @return psErrorcode    the given error code
+ */
 psErrorCode p_psError(
-    const char* file,
-    int lineno,
-    const char* func,
+    const char* file,                  ///< file name
+    int lineno,                        ///< line number in file
+    const char* func,                  ///< function name
     psErrorCode code,                  ///< Error class code
     psBool new,                        ///< true if error originates at this location
-    const char* fmt,
-    ...
+    const char* fmt,                   ///< printf-style format of header line
+    ...                                ///< any parameters required in fmt
 );
+
+/** Logs a warning message.
+ *  
+ *  This procedure logs a message to the destination set by a prior call to
+ *  psLogSetDestination().  This is equivalent to calling psLogMsg with a level of 
+ *  PS_LOG_WARN.  This function is used to check a specific code location.
+ *  
+*/
 void p_psWarning(
-    const char* file,
-    int lineno,
-    const char* func,
-    const char* fmt,
-    ...
+    const char* file,                  ///< file name
+    int lineno,                        ///< line number in file
+    const char* func,                  ///< function name
+    const char* fmt,                   ///< printf-style format of header line
+    ...                                ///< any parameters required in fmt
 );