added doxygen comments

Daniel Marjamäki · Daniel Marjamäki · commit 59c86b5876ea · 2010-12-31T14:16:22.000+01:00
diff --git a/lib/checknullpointer.h b/lib/checknullpointer.h
@@ -101,17 +101,20 @@ class CheckNullPointer : public Check
     void nullPointerError(const Token *tok, const std::string &varname);
     void nullPointerError(const Token *tok, const std::string &varname, const unsigned int line);
 
+    /** Get error messages. Used by --errorlist */
     void getErrorMessages(ErrorLogger *errorLogger, const Settings *settings)
     {
         CheckNullPointer c(0, settings, errorLogger);
         c.nullPointerError(0, "pointer");
     }
 
+    /** Name of check */
     std::string name() const
     {
         return "Null pointer";
     }
 
+    /** class info in WIKI format. Used by --doc */
     std::string classInfo() const
     {
         return "Null pointers\n"

Original file line number	Diff line number	Diff line change
`@@ -101,17 +101,20 @@ class CheckNullPointer : public Check`
`101`	`101`	`void nullPointerError(const Token *tok, const std::string &varname);`
`102`	`102`	`void nullPointerError(const Token *tok, const std::string &varname, const unsigned int line);`
`103`	`103`
	`104`	`+ /** Get error messages. Used by --errorlist */`
`104`	`105`	`void getErrorMessages(ErrorLogger errorLogger, const Settings settings)`
`105`	`106`	`{`
`106`	`107`	`CheckNullPointer c(0, settings, errorLogger);`
`107`	`108`	`c.nullPointerError(0, "pointer");`
`108`	`109`	`}`
`109`	`110`
	`111`	`+ /** Name of check */`
`110`	`112`	`std::string name() const`
`111`	`113`	`{`
`112`	`114`	`return "Null pointer";`
`113`	`115`	`}`
`114`	`116`
	`117`	`+ /** class info in WIKI format. Used by --doc */`
`115`	`118`	`std::string classInfo() const`
`116`	`119`	`{`
`117`	`120`	`return "Null pointers\n"`