From 5a8ba61ffdfc8d55f2aeb568b3d3941cbd804166 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Mon, 19 Jun 2006 23:15:43 +0000 Subject: [PATCH] Reduced the number of doxygen error messages. --- Cantera/src/global.h | 13 +++++++------ Cantera/src/misc.cpp | 8 +++++++- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/Cantera/src/global.h b/Cantera/src/global.h index 016cd0577..e8b2f6ec5 100755 --- a/Cantera/src/global.h +++ b/Cantera/src/global.h @@ -25,22 +25,23 @@ namespace Cantera { class XML_Node; class Logger; - /// Number of errors that have been encountered so far + // Return the number of errors that have been encountered so far int nErrors(); - /// The last error message + // The last error message string lastErrorMessage(); - /// Add an error message + // Set an error condition in the application class without + // throwing an exception. void setError(string r, string msg); - /// Print the error messages to stream f + // Prints all of the error messages to stream f void showErrors(ostream& f); - /// Print the error messages using function writelog. + // Print all of the error messages using function writelog. void showErrors(); - /// Discard the last error message + // Discard the last error message void popError(); /// Find an input file. diff --git a/Cantera/src/misc.cpp b/Cantera/src/misc.cpp index 6d4116e25..edca00118 100755 --- a/Cantera/src/misc.cpp +++ b/Cantera/src/misc.cpp @@ -107,6 +107,9 @@ namespace Cantera { /// Pointer to the single Application instance static Application* s_app = 0; + /** + * Definition of the static member of the Unit class. + */ Unit* Unit::s_u = 0; static void appinit() { @@ -264,8 +267,9 @@ namespace Cantera { string tmpDir() { appinit(); return app()->tmp_dir; } string sleep() { appinit(); return app()->sleep; } + /** - * Returns the number of error messages. + * Return the number of errors that have been encountered so far. * \ingroup errorhandling */ int nErrors() { @@ -309,6 +313,7 @@ namespace Cantera { } /** + * Prints all of the error messages to stream f. * Write out to ostream, f, all of the saved error messages. * Cantera saves a stack of exceptions that it * has caught in the Application class. This routine writes @@ -337,6 +342,7 @@ namespace Cantera { } /** + * Print all of the error messages using function writelog. * Write out all of the saved error messages to the log device. * Cantera saves a stack of exceptions that it * has caught in the Application class. This routine writes