Code comments updated

This commit is contained in:
Reijo Tomperi 2009-02-14 22:00:19 +00:00
parent 669913568c
commit 7ef9e870cd
2 changed files with 12 additions and 18 deletions

View File

@ -36,7 +36,7 @@ class ErrorLogger
public:
/**
* reportErr()
* Wrapper for error messages, provided by reportErr()
*/
class ErrorMessage
{
@ -66,21 +66,18 @@ public:
/**
* Information about progress is directed here.
* Override this to receive the progress messages.
*
* @param outmsg, E.g. "Checking main.cpp..."
*/
virtual void reportOut(const std::string &outmsg) = 0;
/**
* Output of error / warning
* Todo: callstack handling
* Information about found errors and warnings is directed
* here. Override this to receive the errormessages.
*
* @param callStack File names and line numbers where the error
* was found and where it was called from. Error location is last
* element in the list
* @param id error id (function name)
* @param severity severity of error (always, all, style, all+style, never)
* @param msg error message in plain text
* @param msg Location and other information about the found.
* error
*/
virtual void reportErr(const ErrorLogger::ErrorMessage &msg) = 0;

View File

@ -157,7 +157,7 @@ int main()
fout << "public:\n";
fout << "\n";
fout << " /**\n";
fout << " * reportErr()\n";
fout << " * Wrapper for error messages, provided by reportErr()\n";
fout << " */\n";
fout << " class ErrorMessage\n";
fout << " {\n";
@ -187,21 +187,18 @@ int main()
fout << "\n";
fout << " /**\n";
fout << " * Information about progress is directed here.\n";
fout << " * Override this to receive the progress messages.\n";
fout << " *\n";
fout << " * @param outmsg, E.g. \"Checking main.cpp...\"\n";
fout << " */\n";
fout << " virtual void reportOut(const std::string &outmsg) = 0;\n";
fout << "\n";
fout << " /**\n";
fout << " * Output of error / warning\n";
fout << " * Todo: callstack handling\n";
fout << " * Information about found errors and warnings is directed\n";
fout << " * here. Override this to receive the errormessages.\n";
fout << " *\n";
fout << " * @param callStack File names and line numbers where the error\n";
fout << " * was found and where it was called from. Error location is last\n";
fout << " * element in the list\n";
fout << " * @param id error id (function name)\n";
fout << " * @param severity severity of error (always, all, style, all+style, never)\n";
fout << " * @param msg error message in plain text\n";
fout << " * @param msg Location and other information about the found.\n";
fout << " * error\n";
fout << " */\n";
fout << " virtual void reportErr(const ErrorLogger::ErrorMessage &msg) = 0;\n";
fout << "\n";