Doxygen fixes. Wrong parameter names etc.

This commit is contained in:
Kimmo Varis 2009-06-20 12:54:49 +03:00
parent 03944f1b96
commit af994d23e1
5 changed files with 8 additions and 9 deletions

View File

@ -67,7 +67,7 @@ public:
* Refreshes the tree.
*
* @param type Type of error to show/hide
* @param Should specified errors be shown (true) or hidden (false)
* @param show Should specified errors be shown (true) or hidden (false)
*/
void ShowResults(ShowTypes type, bool show);
@ -164,7 +164,6 @@ protected:
* @brief Convert a severity string to a icon filename
*
* @param severity Severity string
* @param Icon filename
*/
QString SeverityToIcon(const QString &severity);
@ -180,7 +179,7 @@ protected:
* @brief Helper function to copy filename/full path to the clipboard
*
* @param target Error tree item to open
* @param fullpath Are we copying full path or only filename?
* @param fullPath Are we copying full path or only filename?
*/
void CopyPath(QStandardItem *target, bool fullPath);
@ -200,7 +199,7 @@ protected:
* @param severity Error severity
* @param message Error message
* @param hide Should this be hidden (true) or shown (false)
* @param addicon Should a default backtrace item icon be added
* @param icon Should a default backtrace item icon be added
* @return newly created QStandardItem *
*/
QStandardItem *AddBacktraceFiles(QStandardItem *parent,

View File

@ -116,7 +116,7 @@ private:
/**
* Errors and warnings are directed here.
*
* @param errmsg Errors messages are normally in format
* @param msg Errors messages are normally in format
* "[filepath:line number] Message", e.g.
* "[main.cpp:4] Uninitialized member variable"
*/
@ -125,7 +125,7 @@ private:
/**
* Information about progress is directed here.
*
* @param outmsg, E.g. "Checking main.cpp..."
* @param outmsg Message to show, e.g. "Checking main.cpp..."
*/
virtual void reportOut(const std::string &outmsg);

View File

@ -74,7 +74,7 @@ private:
/**
* Helper function to print out errors. Appends a line change.
* @param errmsg, string to printed to error stream
* @param errmsg String printed to error stream
*/
void reportErr(const std::string &errmsg);

View File

@ -79,7 +79,7 @@ public:
* Information about progress is directed here.
* Override this to receive the progress messages.
*
* @param outmsg, E.g. "Checking main.cpp..."
* @param outmsg Message to show e.g. "Checking main.cpp..."
*/
virtual void reportOut(const std::string &outmsg) = 0;

View File

@ -169,7 +169,7 @@ public:
/**
* Replace token replaceThis with tokens between start and end,
* including start and end. The replaceThis token is deleted.
* @param replaceThis, this token will be deleted.
* @param replaceThis This token will be deleted.
* @param start This will be in the place of replaceThis
* @param end This is also in the place of replaceThis
*/