diff options
| author | Brad King <brad.king@kitware.com> | 2013-10-08 13:53:13 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-10-08 13:53:13 (GMT) |
| commit | 5a364d8ed54bbfb1d3d6378503b2772256ac2a17 (patch) | |
| tree | 26297218542bfebe10330e1257e8fa576261645d /Source/cmDocumentation.h | |
| parent | cfb2c66f66eaeb4bb2c2d9cc24608fbb49d63986 (diff) | |
| parent | af0051f48ac54ff749faff885f05fb9f34037d5a (diff) | |
| download | CMake-5a364d8ed54bbfb1d3d6378503b2772256ac2a17.zip CMake-5a364d8ed54bbfb1d3d6378503b2772256ac2a17.tar.gz CMake-5a364d8ed54bbfb1d3d6378503b2772256ac2a17.tar.bz2 | |
Merge topic 'clang-warnings'
af0051f curl, bzip2: Suppress warnings by setting initial value
cb4ec60 cmDocumentation: Fix a few doxygen comment errors
d915819 cm*Lexer: Populate empty doxygen @param comment
97124f9 cmTarget: Properly escape @ char in doxygen comments
8e96353 Fix warnings about \brief usage
d993032 cmGraphVizWriter: Add extra space in comment to suppress warning
6cea3ee cmNewLineStyle: Remove useless semi-colon
7e7a1c0 curl: Fix typo in header include guard
Diffstat (limited to 'Source/cmDocumentation.h')
| -rw-r--r-- | Source/cmDocumentation.h | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h index e180f60..218f44d 100644 --- a/Source/cmDocumentation.h +++ b/Source/cmDocumentation.h @@ -154,11 +154,11 @@ public: /** * Retrieve the list of documented module located in * path which match the globing expression globExpr. - * @param[in] path, directory where to start the search + * @param[in] path directory where to start the search * we will recurse into it. - * @param[in] globExpr, the globing expression used to + * @param[in] globExpr the globing expression used to * match the file in path. - * @param[out] the list of obtained pairs (may be empty) + * @param[out] docModuleList the list of obtained pairs (may be empty) * @return 0 on success 1 on error or empty list */ int getDocumentedModulesListInDir( @@ -180,10 +180,9 @@ public: * @param[in] fname the script file name to be parsed for documentation * @param[in,out] commands the vector of command/macros documentation * entry found in the script file. - * @param[in,out] the cmake object instance to which variable documentation - * will be attached (using @see cmake::DefineProperty) - * @param[in] the documentation section in which the property will be - * inserted. + * @param[in,out] cm the cmake object instance to which variable + * documentation will be attached + * (using @see cmake::DefineProperty) * @return the number of documented items (command and variable) * found in the file. */ |