diff --git a/lib/errorlogger.h b/lib/errorlogger.h index 3a92d40d6..ce4ba00ae 100644 --- a/lib/errorlogger.h +++ b/lib/errorlogger.h @@ -187,7 +187,7 @@ public: void setfile(const std::string &file); /** - * Returns the location as a string. Format: [file:line] + * @return the location as a string. Format: [file:line] */ std::string stringify() const; @@ -216,7 +216,8 @@ public: * @param verbose use verbose message * @param outputFormat Empty string to use default output format * or template to be used. E.g. "{file}:{line},{severity},{id},{message}" - */ + * @return formatted string + */ std::string toString(bool verbose, const std::string &outputFormat = "") const; std::string serialize() const; diff --git a/lib/path.h b/lib/path.h index 4bc5e616e..f369521a8 100644 --- a/lib/path.h +++ b/lib/path.h @@ -108,7 +108,7 @@ public: * @brief Check if the file extension indicates that it's a C/C++ source file. * Check if the file has source file extension: *.c;*.cpp;*.cxx;*.c++;*.cc;*.txx * @param filename filename to check. path info is optional - * @return returns true if the file extension indicates it should be checked + * @return true if the file extension indicates it should be checked */ static bool acceptFile(const std::string &filename) { const std::set extra; @@ -120,7 +120,7 @@ public: * Check if the file has source file extension: *.c;*.cpp;*.cxx;*.c++;*.cc;*.txx * @param filename filename to check. path info is optional * @param extra extra file extensions - * @return returns true if the file extension indicates it should be checked + * @return true if the file extension indicates it should be checked */ static bool acceptFile(const std::string &filename, const std::set &extra); diff --git a/lib/symboldatabase.h b/lib/symboldatabase.h index 0f1c98cc2..bed760c6d 100644 --- a/lib/symboldatabase.h +++ b/lib/symboldatabase.h @@ -723,7 +723,7 @@ public: /** * @brief get the number of nested scopes that are not functions * - * This returns the number of user defined types (class, struct, union) + * @return the number of user defined types (class, struct, union) * that are defined in this user defined type or namespace. */ unsigned int getNestedNonFunctions() const; diff --git a/lib/tokenize.h b/lib/tokenize.h index cd551318c..bdf30352e 100644 --- a/lib/tokenize.h +++ b/lib/tokenize.h @@ -48,7 +48,7 @@ public: m_timerResults = tr; } - /** Returns the source file path. e.g. "file.cpp" */ + /** @return the source file path. e.g. "file.cpp" */ const std::string& getSourceFilePath() const; /** Is the code C. Used for bailouts */ @@ -494,7 +494,7 @@ public: /** * Simplify e.g. 'atol("0")' into '0' - * @return returns true if simplifcations performed and false otherwise. + * @return true if simplifcations performed and false otherwise. */ bool simplifyMathFunctions();