Attempt to fix all doxygen warnings.

This commit is contained in:
Edoardo Prezioso 2012-10-24 01:20:14 +02:00
parent e7483af028
commit b50e1f4451
7 changed files with 11 additions and 8 deletions

View File

@ -179,7 +179,7 @@ public slots:
void Save();
/**
* @brief Slot to create new project file..
* @brief Slot to create new project file
*
*/
void NewProjectFile();

View File

@ -121,7 +121,7 @@ bool ShowTypes::isShown(Severity::SeverityType severity) const
return isShown(ShowTypes::SeverityToShowType(severity));
}
void ShowTypes::show(ShowTypes::ShowType category, bool show)
void ShowTypes::show(ShowTypes::ShowType category, bool showing)
{
mVisible[category] = show;
mVisible[category] = showing;
}

View File

@ -89,9 +89,9 @@ public:
/**
* @brief Show/hide the showtype.
* @param category Showtype whose visibility to set.
* @return true if the severity is set visible.
* @param showing true if the severity is set visible.
*/
void show(ShowTypes::ShowType category, bool show);
void show(ShowTypes::ShowType category, bool showing);
/**
* @brief Convert severity string to ShowTypes value

View File

@ -71,9 +71,10 @@ private:
/**
* Returning a temporary object?
* @param tok pointing at the "return" token
* @param startScope indicates the function scope to be checked
* @return true if a temporary object is returned
*/
bool returnTemporary(const Token *tok, const Scope *scope) const;
bool returnTemporary(const Token *tok, const Scope *startScope) const;
void errorReturnAddressToAutoVariable(const Token *tok);
void errorReturnPointerToLocalArray(const Token *tok);

View File

@ -137,7 +137,8 @@ public:
/**
* Dereferencing an erased iterator
* @param tok token where error occurs
* @param erased token where the erase occurs
* @param deref token where the dereference occurs
* @param itername iterator name
*/
void dereferenceErasedError(const Token* erased, const Token* deref, const std::string &itername);

View File

@ -1805,6 +1805,7 @@ Preprocessor::HeaderTypes Preprocessor::getHeaderFileName(std::string &str)
* Try to open header
* @param filename header name (in/out)
* @param includePaths paths where to look for the file
* @param filePath path to the header file
* @param fin file input stream (in/out)
* @return if file is opened then true is returned
*/

View File

@ -94,7 +94,7 @@ public:
/**
* Get preprocessed code for a given configuration
* @param filedata file data including #if, #define, etc
* @param filedata file data including preprocessing 'if', 'define', etc
* @param cfg configuration to read out
* @param filename name of source file
* @param validate true => perform validation that empty configuration macros are not used in the code