From 12df5300baded52b7b2e5ad983d7488505b032d2 Mon Sep 17 00:00:00 2001 From: Alexander Mai Date: Wed, 1 Jan 2014 20:46:00 +0100 Subject: [PATCH] Fixed #5290 (Doxygen fixes (32be409)) --- gui/mainwindow.h | 2 +- gui/projectfiledialog.h | 4 ++-- lib/checkautovariables.h | 1 + lib/checkunusedfunctions.h | 1 + lib/token.h | 16 ++++++++-------- 5 files changed, 13 insertions(+), 11 deletions(-) diff --git a/gui/mainwindow.h b/gui/mainwindow.h index 3ecfca49a..864276b6a 100644 --- a/gui/mainwindow.h +++ b/gui/mainwindow.h @@ -426,7 +426,7 @@ private: /** * @brief Load library file - * @param Library library to use + * @param library library to use * @param filename filename (no path) * @return True if successful */ diff --git a/gui/projectfiledialog.h b/gui/projectfiledialog.h index 66481de78..58c9a0ed2 100644 --- a/gui/projectfiledialog.h +++ b/gui/projectfiledialog.h @@ -115,13 +115,13 @@ public: /** * @brief Set libraries to dialog control. - * @param paths List of libraries to set to dialog control. + * @param libraries List of libraries to set to dialog control. */ void SetLibraries(const QStringList &libraries); /** * @brief Set suppressions to dialog control. - * @param paths List of suppressions to set to dialog control. + * @param suppressions List of suppressions to set to dialog control. */ void SetSuppressions(const QStringList &suppressions); diff --git a/lib/checkautovariables.h b/lib/checkautovariables.h index a2624c463..6c0fa450e 100644 --- a/lib/checkautovariables.h +++ b/lib/checkautovariables.h @@ -27,6 +27,7 @@ #include "token.h" /// @addtogroup Checks +/** @brief Various small checks for automatic variables */ /// @{ diff --git a/lib/checkunusedfunctions.h b/lib/checkunusedfunctions.h index 367705e4b..91690ffbb 100644 --- a/lib/checkunusedfunctions.h +++ b/lib/checkunusedfunctions.h @@ -28,6 +28,7 @@ #include "errorlogger.h" /// @addtogroup Checks +/** @brief Check for functions never called */ /// @{ class CPPCHECKLIB CheckUnusedFunctions: public Check { diff --git a/lib/token.h b/lib/token.h index 13e5bb6c5..ef8f3274c 100644 --- a/lib/token.h +++ b/lib/token.h @@ -147,15 +147,15 @@ public: * - "!!else" No tokens or any token that is not "else". * - "someRandomText" If token contains "someRandomText". * - * multi-compare patterns such as "int|void|char" can contain %or%, %oror% and %op% - * but it is not recommended to put such an %cmd% as the first pattern. + * multi-compare patterns such as "int|void|char" can contain %%or%, %%oror% and %%op% + * but it is not recommended to put such an %%cmd% as the first pattern. * - * It's possible to use multi-compare patterns with all the other %cmds%, - * except for %varid%, and normal names, but the %cmds% should be put as + * It's possible to use multi-compare patterns with all the other %%cmds%, + * except for %%varid%, and normal names, but the %%cmds% should be put as * the first patterns in the list, then the normal names. * For example: "%var%|%num%|)" means yes to a variable, a number or ')'. * - * @todo Make it possible to use the %cmds% and the normal names in the + * @todo Make it possible to use the %%cmds% and the normal names in the * multicompare list without an order. * * The patterns can be also combined to compare to multiple tokens at once @@ -167,7 +167,7 @@ public: * @param tok List of tokens to be compared to the pattern * @param pattern The pattern against which the tokens are compared, * e.g. "const" or ") const|volatile| {". - * @param varid if %varid% is given in the pattern the Token::varId + * @param varid if %%varid% is given in the pattern the Token::varId * will be matched against this argument * @return true if given token matches with given pattern * false if given token does not match with given pattern @@ -177,7 +177,7 @@ public: /** * Return length of C-string. * - * Should be called for %str% tokens only. + * Should be called for %%str%% tokens only. * * @param tok token with C-string **/ @@ -186,7 +186,7 @@ public: /** * Return char of C-string at index (possible escaped "\\n") * - * Should be called for %str% tokens only. + * Should be called for %%str%% tokens only. * * @param tok token with C-string * @param index position of character