Doxygen: Fix warnings.

This commit is contained in:
Nicolas Despres 2011-03-20 14:22:39 +01:00
parent faede37b79
commit a92f14f338
11 changed files with 24 additions and 23 deletions

View File

@ -72,7 +72,7 @@ protected:
CreateComponentGroupDescription(cmCPackComponentGroup *group, CreateComponentGroupDescription(cmCPackComponentGroup *group,
cmOStringStream& macrosOut); cmOStringStream& macrosOut);
/// Translations any newlines found in the string into \r\n, so that the /// Translations any newlines found in the string into \\r\\n, so that the
/// resulting string can be used within NSIS. /// resulting string can be used within NSIS.
static std::string TranslateNewlines(std::string str); static std::string TranslateNewlines(std::string str);
}; };

View File

@ -24,7 +24,7 @@ class cmCTestLaunch
{ {
public: public:
/** Entry point from ctest executable main(). */ /** Entry point from ctest executable main(). */
static int Main(int argc, const char* const* argv); static int Main(int argc, const char* const argv[]);
private: private:
// Initialize the launcher from its command line. // Initialize the launcher from its command line.
cmCTestLaunch(int argc, const char* const* argv); cmCTestLaunch(int argc, const char* const* argv);

View File

@ -75,7 +75,9 @@ private:
const cmStdString& remoteprefix, const cmStdString& remoteprefix,
const cmStdString& url); const cmStdString& url);
void ParseResponse(std::vector<char>); typedef std::vector<char> cmCTestSubmitHandlerVectorOfChar;
void ParseResponse(cmCTestSubmitHandlerVectorOfChar chunk);
std::string GetSubmitResultsPrefix(); std::string GetSubmitResultsPrefix();

View File

@ -1672,9 +1672,9 @@ YY_BUFFER_STATE cmCommandArgument_yy_scan_string (yyconst char * yystr , yyscan_
} }
/** Setup the input buffer state to scan the given bytes. The next call to cmCommandArgument_yylex() will /** Setup the input buffer state to scan the given bytes. The next call to cmCommandArgument_yylex() will
* scan from a @e copy of @a bytes. * scan from a @e copy of @a yybytes.
* @param bytes the byte buffer to scan * @param yybytes the byte buffer to scan
* @param len the number of bytes in the buffer pointed to by @a bytes. * @param _yybytes_len the number of bytes in the buffer pointed to by @a bytes.
* @param yyscanner The scanner object. * @param yyscanner The scanner object.
* @return the newly allocated buffer state object. * @return the newly allocated buffer state object.
*/ */
@ -1835,7 +1835,7 @@ void cmCommandArgument_yyset_lineno (int line_number , yyscan_t yyscanner)
} }
/** Set the current column. /** Set the current column.
* @param line_number * @param column_no
* @param yyscanner The scanner object. * @param yyscanner The scanner object.
*/ */
void cmCommandArgument_yyset_column (int column_no , yyscan_t yyscanner) void cmCommandArgument_yyset_column (int column_no , yyscan_t yyscanner)

View File

@ -1991,9 +1991,9 @@ YY_BUFFER_STATE cmDependsFortran_yy_scan_string (yyconst char * yystr , yyscan_t
} }
/** Setup the input buffer state to scan the given bytes. The next call to cmDependsFortran_yylex() will /** Setup the input buffer state to scan the given bytes. The next call to cmDependsFortran_yylex() will
* scan from a @e copy of @a bytes. * scan from a @e copy of @a yybytes.
* @param bytes the byte buffer to scan * @param yybytes the byte buffer to scan
* @param len the number of bytes in the buffer pointed to by @a bytes. * @param _yybytes_len the number of bytes in the buffer pointed to by @a bytes.
* @param yyscanner The scanner object. * @param yyscanner The scanner object.
* @return the newly allocated buffer state object. * @return the newly allocated buffer state object.
*/ */
@ -2154,7 +2154,7 @@ void cmDependsFortran_yyset_lineno (int line_number , yyscan_t yyscanner)
} }
/** Set the current column. /** Set the current column.
* @param line_number * @param column_no
* @param yyscanner The scanner object. * @param yyscanner The scanner object.
*/ */
void cmDependsFortran_yyset_column (int column_no , yyscan_t yyscanner) void cmDependsFortran_yyset_column (int column_no , yyscan_t yyscanner)

View File

@ -2168,8 +2168,8 @@ YY_BUFFER_STATE cmDependsJava_yy_scan_buffer (char * base, yy_size_t size , yy
} }
/** Setup the input buffer state to scan a string. The next call to cmDependsJava_yylex() will /** Setup the input buffer state to scan a string. The next call to cmDependsJava_yylex() will
* scan from a @e copy of @a str. * scan from a @e copy of @a yy_str.
* @param str a NUL-terminated string to scan * @param yy_str a NUL-terminated string to scan
* @param yyscanner The scanner object. * @param yyscanner The scanner object.
* @return the newly allocated buffer state object. * @return the newly allocated buffer state object.
* @note If you want to scan bytes that may contain NUL values, then use * @note If you want to scan bytes that may contain NUL values, then use
@ -2345,7 +2345,7 @@ void cmDependsJava_yyset_lineno (int line_number , yyscan_t yyscanner)
} }
/** Set the current column. /** Set the current column.
* @param line_number * @param column_no
* @param yyscanner The scanner object. * @param yyscanner The scanner object.
*/ */
void cmDependsJava_yyset_column (int column_no , yyscan_t yyscanner) void cmDependsJava_yyset_column (int column_no , yyscan_t yyscanner)

View File

@ -60,7 +60,7 @@ public:
std::vector<const cmDocumentationSection *>&) std::vector<const cmDocumentationSection *>&)
{} {}
/** Compute a prefix for links into a section (#<prefix>_SOMETHING). */ /** Compute a prefix for links into a section (#\<prefix\>_SOMETHING). */
std::string ComputeSectionLinkPrefix(std::string const& name); std::string ComputeSectionLinkPrefix(std::string const& name);
}; };

View File

@ -1554,8 +1554,7 @@ YY_BUFFER_STATE cmExpr_yy_scan_buffer (char * base, yy_size_t size , yyscan_t
} }
/** Setup the input buffer state to scan a string. The next call to cmExpr_yylex() will /** Setup the input buffer state to scan a string. The next call to cmExpr_yylex() will
* scan from a @e copy of @a str. * scan from a @e copy of @a yy_str.
* @param str a NUL-terminated string to scan
* @param yy_str a NUL-terminated string to scan * @param yy_str a NUL-terminated string to scan
* @param yyscanner The scanner object. * @param yyscanner The scanner object.
* @return the newly allocated buffer state object. * @return the newly allocated buffer state object.
@ -1732,7 +1731,7 @@ void cmExpr_yyset_lineno (int line_number , yyscan_t yyscanner)
} }
/** Set the current column. /** Set the current column.
* @param line_number * @param column_no
* @param yyscanner The scanner object. * @param yyscanner The scanner object.
*/ */
void cmExpr_yyset_column (int column_no , yyscan_t yyscanner) void cmExpr_yyset_column (int column_no , yyscan_t yyscanner)

View File

@ -23,8 +23,8 @@ class cmLocalGenerator;
* cmGlobalKdevelopGenerator produces a project file for KDevelop 3 (KDevelop * cmGlobalKdevelopGenerator produces a project file for KDevelop 3 (KDevelop
* > 3.1.1). The project is based on the "Custom Makefile based C/C++" * > 3.1.1). The project is based on the "Custom Makefile based C/C++"
* project of KDevelop. Such a project consists of Unix Makefiles in the * project of KDevelop. Such a project consists of Unix Makefiles in the
* build directory together with a <your_project>.kdevelop project file, * build directory together with a \<your_project\>.kdevelop project file,
* which contains the project settings and a <your_project>.kdevelop.filelist * which contains the project settings and a \<your_project\>.kdevelop.filelist
* file, which lists the source files relative to the kdevelop project * file, which lists the source files relative to the kdevelop project
* directory. The kdevelop project directory is the base source directory. * directory. The kdevelop project directory is the base source directory.
*/ */

View File

@ -36,7 +36,7 @@ class cmLocalUnixMakefileGenerator3;
targets that are required to make the process work. targets that are required to make the process work.
Makefile2 in turn will recursively make targets in the correct order. Each Makefile2 in turn will recursively make targets in the correct order. Each
target has its own directory <target>.dir and its own makefile build.make in target has its own directory \<target\>.dir and its own makefile build.make in
that directory. Also in that directory is a couple makefiles per source file that directory. Also in that directory is a couple makefiles per source file
used by the target. Typically these are named source.obj.build.make and used by the target. Typically these are named source.obj.build.make and
source.obj.build.depend.make. The source.obj.build.make contains the rules source.obj.build.depend.make. The source.obj.build.make contains the rules

View File

@ -668,7 +668,7 @@ public:
* Expand all defined variables in the string. * Expand all defined variables in the string.
* Defined variables come from the this->Definitions map. * Defined variables come from the this->Definitions map.
* They are expanded with ${var} where var is the * They are expanded with ${var} where var is the
* entry in the this->Definitions map. Also @var@ is * entry in the this->Definitions map. Also \@var\@ is
* expanded to match autoconf style expansions. * expanded to match autoconf style expansions.
*/ */
const char *ExpandVariablesInString(std::string& source); const char *ExpandVariablesInString(std::string& source);
@ -682,7 +682,7 @@ public:
/** /**
* Remove any remaining variables in the string. Anything with ${var} or * Remove any remaining variables in the string. Anything with ${var} or
* @var@ will be removed. * \@var\@ will be removed.
*/ */
void RemoveVariablesInString(std::string& source, void RemoveVariablesInString(std::string& source,
bool atOnly = false) const; bool atOnly = false) const;