Bladeren bron

Doxygen: Fix warnings.

Nicolas Despres 14 jaren geleden
bovenliggende
commit
a92f14f338

+ 1 - 1
Source/CPack/cmCPackNSISGenerator.h

@@ -72,7 +72,7 @@ protected:
   CreateComponentGroupDescription(cmCPackComponentGroup *group,
                                   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.
   static std::string TranslateNewlines(std::string str);
 };

+ 1 - 1
Source/CTest/cmCTestLaunch.h

@@ -24,7 +24,7 @@ class cmCTestLaunch
 {
 public:
   /** 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:
   // Initialize the launcher from its command line.
   cmCTestLaunch(int argc, const char* const* argv);

+ 3 - 1
Source/CTest/cmCTestSubmitHandler.h

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

+ 4 - 4
Source/cmCommandArgumentLexer.cxx

@@ -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
- * scan from a @e copy of @a bytes.
- * @param bytes the byte buffer to scan
- * @param len the number of bytes in the buffer pointed to by @a bytes.
+ * scan from a @e copy of @a yybytes.
+ * @param yybytes the byte buffer to scan
+ * @param _yybytes_len the number of bytes in the buffer pointed to by @a bytes.
  * @param yyscanner The scanner 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.
- * @param line_number
+ * @param column_no
  * @param yyscanner The scanner object.
  */
 void cmCommandArgument_yyset_column (int  column_no , yyscan_t yyscanner)

+ 4 - 4
Source/cmDependsFortranLexer.cxx

@@ -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
- * scan from a @e copy of @a bytes.
- * @param bytes the byte buffer to scan
- * @param len the number of bytes in the buffer pointed to by @a bytes.
+ * scan from a @e copy of @a yybytes.
+ * @param yybytes the byte buffer to scan
+ * @param _yybytes_len the number of bytes in the buffer pointed to by @a bytes.
  * @param yyscanner The scanner 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.
- * @param line_number
+ * @param column_no
  * @param yyscanner The scanner object.
  */
 void cmDependsFortran_yyset_column (int  column_no , yyscan_t yyscanner)

+ 3 - 3
Source/cmDependsJavaLexer.cxx

@@ -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
- * scan from a @e copy of @a str.
- * @param str a NUL-terminated string to scan
+ * scan from a @e copy of @a yy_str.
+ * @param yy_str a NUL-terminated string to scan
  * @param yyscanner The scanner object.
  * @return the newly allocated buffer state object.
  * @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.
- * @param line_number
+ * @param column_no
  * @param yyscanner The scanner object.
  */
 void cmDependsJava_yyset_column (int  column_no , yyscan_t yyscanner)

+ 1 - 1
Source/cmDocumentationFormatter.h

@@ -60,7 +60,7 @@ public:
                           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);
 };
 

+ 2 - 3
Source/cmExprLexer.cxx

@@ -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
- * scan from a @e copy of @a str.
- * @param str a NUL-terminated string to scan
+ * scan from a @e copy of @a yy_str.
  * @param yy_str a NUL-terminated string to scan
  * @param yyscanner The scanner 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.
- * @param line_number
+ * @param column_no
  * @param yyscanner The scanner object.
  */
 void cmExpr_yyset_column (int  column_no , yyscan_t yyscanner)

+ 2 - 2
Source/cmGlobalKdevelopGenerator.h

@@ -23,8 +23,8 @@ class cmLocalGenerator;
  * cmGlobalKdevelopGenerator produces a project file for KDevelop 3 (KDevelop
  * > 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
- * build directory together with a <your_project>.kdevelop project file,
- * which contains the project settings and a <your_project>.kdevelop.filelist
+ * build directory together with a \<your_project\>.kdevelop project file,
+ * which contains the project settings and a \<your_project\>.kdevelop.filelist
  * file, which lists the source files relative to the kdevelop project
  * directory. The kdevelop project directory is the base source directory.
  */

+ 1 - 1
Source/cmGlobalUnixMakefileGenerator3.h

@@ -36,7 +36,7 @@ class cmLocalUnixMakefileGenerator3;
  targets that are required to make the process work.
 
  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
  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

+ 2 - 2
Source/cmMakefile.h

@@ -668,7 +668,7 @@ public:
    * Expand all defined variables in the string.
    * Defined variables come from the this->Definitions map.
    * 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.
    */
   const char *ExpandVariablesInString(std::string& source);
@@ -682,7 +682,7 @@ public:
 
   /**
    * Remove any remaining variables in the string. Anything with ${var} or
-   * @var@ will be removed.
+   * \@var\@ will be removed.
    */
   void RemoveVariablesInString(std::string& source,
                                bool atOnly = false) const;