Small enhancements for doxygen

amai2012 · amai2012 · commit ead3f28e0643 · 2014-04-27T21:42:10.000+02:00
diff --git a/lib/errorlogger.h b/lib/errorlogger.h
@@ -187,7 +187,7 @@ class CPPCHECKLIB ErrorLogger {
             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 @@ class CPPCHECKLIB ErrorLogger {
          * @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
@@ -108,7 +108,7 @@ class CPPCHECKLIB Path {
      * @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<std::string> extra;
@@ -120,7 +120,7 @@ class CPPCHECKLIB Path {
      * 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<std::string> &extra);
 
diff --git a/lib/symboldatabase.h b/lib/symboldatabase.h
@@ -723,7 +723,7 @@ class CPPCHECKLIB Scope {
     /**
      * @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
@@ -48,7 +48,7 @@ class CPPCHECKLIB Tokenizer {
         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 @@ class CPPCHECKLIB Tokenizer {
 
     /**
      * 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();
 

Original file line number	Diff line number	Diff line change
`@@ -723,7 +723,7 @@ class CPPCHECKLIB Scope {`
`723`	`723`	`/**`
`724`	`724`	`* @brief get the number of nested scopes that are not functions`
`725`	`725`	`*`
`726`		`- * This returns the number of user defined types (class, struct, union)`
	`726`	`+ * @return the number of user defined types (class, struct, union)`
`727`	`727`	`* that are defined in this user defined type or namespace.`
`728`	`728`	`*/`
`729`	`729`	`unsigned int getNestedNonFunctions() const;`