diff options
author | Eric NOULARD <eric.noulard@gmail.com> | 2011-11-15 19:24:38 (GMT) |
---|---|---|
committer | Eric NOULARD <eric.noulard@gmail.com> | 2012-01-22 10:44:05 (GMT) |
commit | 83e34dd9e688b4721c70c56e66629bdc2768fa77 (patch) | |
tree | bae87f4bb777b7c9e73d77628f52da25add82b4c /Modules/CPack.cmake | |
parent | c6a016944211b737c45385423fc7df10462e34ab (diff) | |
download | CMake-83e34dd9e688b4721c70c56e66629bdc2768fa77.zip CMake-83e34dd9e688b4721c70c56e66629bdc2768fa77.tar.gz CMake-83e34dd9e688b4721c70c56e66629bdc2768fa77.tar.bz2 |
Implement simple CMake script comment markup language.
The language is very simple. It use ##<keyword> special comment
which opens a structured documentation block and ##end closes it.
This may be used to extract documentation for macro as 'command'
and 'variables' such that cpack --help-command and --help-variable
does parse builtin modules files (CPack.cmake, CPackComponent.cmake,
...) in order to extract the corresponding doc.
Diffstat (limited to 'Modules/CPack.cmake')
-rw-r--r-- | Modules/CPack.cmake | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake index 2cc27cf..ce59693 100644 --- a/Modules/CPack.cmake +++ b/Modules/CPack.cmake @@ -49,21 +49,33 @@ # there are a variety of variables that can be set to customize # the resulting installers. The most commonly-used variables are: # +##variable # CPACK_PACKAGE_NAME - The name of the package (or application). If # not specified, defaults to the project name. +##end # +##variable # CPACK_PACKAGE_VENDOR - The name of the package vendor (e.g., # "Kitware"). +##end # +##variable # CPACK_PACKAGE_VERSION_MAJOR - Package major Version +##end # +##variable # CPACK_PACKAGE_VERSION_MINOR - Package minor Version +##end # +##variable # CPACK_PACKAGE_VERSION_PATCH - Package patch Version +##end # +##variable # CPACK_PACKAGE_DESCRIPTION_FILE - A text file used to describe the # project. Used, for example, the introduction screen of a # CPack-generated Windows installer to describe the project. +##end # # CPACK_PACKAGE_DESCRIPTION_SUMMARY - Short description of the # project (only a few words). |