Merge topic 'fixDocumentationComment'

e507bf2 CPack: Fix clang -Wdocumentation warnings
This commit is contained in:
Brad King 2013-10-07 15:44:54 -04:00 committed by CMake Topic Stage
commit c7384a053e
1 changed files with 5 additions and 4 deletions

View File

@ -160,9 +160,10 @@ protected:
* CPack specific generator may mangle CPACK_PACKAGE_FILE_NAME * CPack specific generator may mangle CPACK_PACKAGE_FILE_NAME
* with CPACK_COMPONENT_xxxx_<NAME>_DISPLAY_NAME if * with CPACK_COMPONENT_xxxx_<NAME>_DISPLAY_NAME if
* CPACK_<GEN>_USE_DISPLAY_NAME_IN_FILENAME is ON. * CPACK_<GEN>_USE_DISPLAY_NAME_IN_FILENAME is ON.
* @param[in] initialPackageFileName * @param[in] initialPackageFileName the initial package name to be mangled
* @param[in] groupOrComponentName * @param[in] groupOrComponentName the name of the group/component
* @param[in] isGroupName * @param[in] isGroupName true if previous name refers to a group,
* false otherwise
*/ */
virtual std::string GetComponentPackageFileName( virtual std::string GetComponentPackageFileName(
const std::string& initialPackageFileName, const std::string& initialPackageFileName,
@ -172,7 +173,7 @@ protected:
/** /**
* Package the list of files and/or components which * Package the list of files and/or components which
* has been prepared by the beginning of DoPackage. * 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 the list of file @ref files has been populated
* @pre packageFileNames contains at least 1 entry * @pre packageFileNames contains at least 1 entry
* @post packageFileNames may have been updated and contains * @post packageFileNames may have been updated and contains