summaryrefslogtreecommitdiffstats
path: root/Source
diff options
context:
space:
mode:
authorSean McBride <sean@rogue-research.com>2013-09-19 17:08:38 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-08 13:16:32 (GMT)
commitcb4ec606a9e13ed4064fd8f72f00e51ec09ea537 (patch)
treef72cfc47889179b4239dfb4cca610a2febc70e5b /Source
parentd915819ad1a6c0dafb38dc12c1e1329d8130403f (diff)
downloadCMake-cb4ec606a9e13ed4064fd8f72f00e51ec09ea537.zip
CMake-cb4ec606a9e13ed4064fd8f72f00e51ec09ea537.tar.gz
CMake-cb4ec606a9e13ed4064fd8f72f00e51ec09ea537.tar.bz2
cmDocumentation: Fix a few doxygen comment errors
Warned by clang -Wdocumentation
Diffstat (limited to 'Source')
-rw-r--r--Source/cmDocumentation.h13
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.
*/