summaryrefslogtreecommitdiffstats
path: root/Source/CPack/cmCPackGenerator.h
diff options
context:
space:
mode:
authorEric NOULARD <eric.noulard@gmail.com>2013-09-24 12:29:24 (GMT)
committerEric NOULARD <eric.noulard@gmail.com>2013-09-24 12:29:24 (GMT)
commite507bf28c2993730b0c6c8c19a4a93a9128b41cb (patch)
tree06934a56240397ef10c45d25aaa41c5b07f9fa4a /Source/CPack/cmCPackGenerator.h
parente5538f323eede6a46fad5f8a5fe04fd5f5ab23ce (diff)
downloadCMake-e507bf28c2993730b0c6c8c19a4a93a9128b41cb.zip
CMake-e507bf28c2993730b0c6c8c19a4a93a9128b41cb.tar.gz
CMake-e507bf28c2993730b0c6c8c19a4a93a9128b41cb.tar.bz2
CPack: Fix clang -Wdocumentation warnings
Diffstat (limited to 'Source/CPack/cmCPackGenerator.h')
-rw-r--r--Source/CPack/cmCPackGenerator.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/Source/CPack/cmCPackGenerator.h b/Source/CPack/cmCPackGenerator.h
index 8fafef9..5cb2280 100644
--- a/Source/CPack/cmCPackGenerator.h
+++ b/Source/CPack/cmCPackGenerator.h
@@ -160,9 +160,10 @@ protected:
* CPack specific generator may mangle CPACK_PACKAGE_FILE_NAME
* with CPACK_COMPONENT_xxxx_<NAME>_DISPLAY_NAME if
* CPACK_<GEN>_USE_DISPLAY_NAME_IN_FILENAME is ON.
- * @param[in] initialPackageFileName
- * @param[in] groupOrComponentName
- * @param[in] isGroupName
+ * @param[in] initialPackageFileName the initial package name to be mangled
+ * @param[in] groupOrComponentName the name of the group/component
+ * @param[in] isGroupName true if previous name refers to a group,
+ * false otherwise
*/
virtual std::string GetComponentPackageFileName(
const std::string& initialPackageFileName,
@@ -172,7 +173,7 @@ protected:
/**
* Package the list of files and/or components which
* has been prepared by the beginning of DoPackage.
- * @pre @ref toplevel has been filled-in
+ * @pre the @ref toplevel has been filled-in
* @pre the list of file @ref files has been populated
* @pre packageFileNames contains at least 1 entry
* @post packageFileNames may have been updated and contains