summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorEric NOULARD <eric.noulard@gmail.com>2011-11-15 19:24:38 (GMT)
committerEric NOULARD <eric.noulard@gmail.com>2012-01-22 10:44:05 (GMT)
commit83e34dd9e688b4721c70c56e66629bdc2768fa77 (patch)
treebae87f4bb777b7c9e73d77628f52da25add82b4c /Modules
parentc6a016944211b737c45385423fc7df10462e34ab (diff)
downloadCMake-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')
-rw-r--r--Modules/CPack.cmake12
-rw-r--r--Modules/CPackComponent.cmake8
2 files changed, 20 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).
diff --git a/Modules/CPackComponent.cmake b/Modules/CPackComponent.cmake
index 1c10372..a0e0667 100644
--- a/Modules/CPackComponent.cmake
+++ b/Modules/CPackComponent.cmake
@@ -21,6 +21,7 @@
# INSTALL commands, and should be further described by the following
# CPack commands:
#
+##macro
# cpack_add_component - Describes a CPack installation component
# named by the COMPONENT argument to a CMake INSTALL command.
#
@@ -90,7 +91,9 @@
# create a file with some name based on CPACK_PACKAGE_FILE_NAME and
# the name of the component. See cpack_configure_downloads for more
# information.
+##end
#
+##macro
# cpack_add_component_group - Describes a group of related CPack
# installation components.
#
@@ -134,7 +137,9 @@
#
# BOLD_TITLE indicates that the group title should appear in bold,
# to call the user's attention to the group.
+##end
#
+##macro
# cpack_add_install_type - Add a new installation type containing a
# set of predefined component selections to the graphical installer.
#
@@ -153,7 +158,9 @@
# DISPLAY_NAME is the displayed name of the install type, which will
# typically show up in a drop-down box within a graphical
# installer. This value can be any string.
+##end
#
+##macro
# cpack_configure_downloads - Configure CPack to download selected
# components on-the-fly as part of the installation process.
#
@@ -203,6 +210,7 @@
# that can be called from Windows' Add/Remove Programs dialog (via the
# "Modify" button) to change the set of installed components. NO_ADD_REMOVE
# turns off this behavior. This option is ignored on Mac OS X.
+##endmacro
#=============================================================================
# Copyright 2006-2009 Kitware, Inc.