summaryrefslogtreecommitdiffstats
path: root/Modules/FeatureSummary.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-10-22 19:52:31 (GMT)
committerBrad King <brad.king@kitware.com>2014-10-22 19:52:31 (GMT)
commit58b2d760ee094e6f1a4a8701f86efcb81977b047 (patch)
tree2cf1d02b16f8519155779e052dd21639894fb226 /Modules/FeatureSummary.cmake
parent54ff77dc621a91302abad0ab38d9bd26de8914b9 (diff)
downloadCMake-58b2d760ee094e6f1a4a8701f86efcb81977b047.zip
CMake-58b2d760ee094e6f1a4a8701f86efcb81977b047.tar.gz
CMake-58b2d760ee094e6f1a4a8701f86efcb81977b047.tar.bz2
Modules: Format documentation to avoid over-long preformatted lines
Convert several preformatted code block literals that enumerate lists of options or variables to use reST definition lists instead. Manually wrap other long lines in code blocks.
Diffstat (limited to 'Modules/FeatureSummary.cmake')
-rw-r--r--Modules/FeatureSummary.cmake70
1 files changed, 43 insertions, 27 deletions
diff --git a/Modules/FeatureSummary.cmake b/Modules/FeatureSummary.cmake
index 12ea384..37bc6b5 100644
--- a/Modules/FeatureSummary.cmake
+++ b/Modules/FeatureSummary.cmake
@@ -55,21 +55,32 @@
# The WHAT option is the only mandatory option. Here you specify what
# information will be printed:
#
-# ::
-#
-# ALL: print everything
-# ENABLED_FEATURES: the list of all features which are enabled
-# DISABLED_FEATURES: the list of all features which are disabled
-# PACKAGES_FOUND: the list of all packages which have been found
-# PACKAGES_NOT_FOUND: the list of all packages which have not been found
-# OPTIONAL_PACKAGES_FOUND: only those packages which have been found which have the type OPTIONAL
-# OPTIONAL_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type OPTIONAL
-# RECOMMENDED_PACKAGES_FOUND: only those packages which have been found which have the type RECOMMENDED
-# RECOMMENDED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RECOMMENDED
-# REQUIRED_PACKAGES_FOUND: only those packages which have been found which have the type REQUIRED
-# REQUIRED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type REQUIRED
-# RUNTIME_PACKAGES_FOUND: only those packages which have been found which have the type RUNTIME
-# RUNTIME_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RUNTIME
+# ``ALL``
+# print everything
+# ``ENABLED_FEATURES``
+# the list of all features which are enabled
+# ``DISABLED_FEATURES``
+# the list of all features which are disabled
+# ``PACKAGES_FOUND``
+# the list of all packages which have been found
+# ``PACKAGES_NOT_FOUND``
+# the list of all packages which have not been found
+# ``OPTIONAL_PACKAGES_FOUND``
+# only those packages which have been found which have the type OPTIONAL
+# ``OPTIONAL_PACKAGES_NOT_FOUND``
+# only those packages which have not been found which have the type OPTIONAL
+# ``RECOMMENDED_PACKAGES_FOUND``
+# only those packages which have been found which have the type RECOMMENDED
+# ``RECOMMENDED_PACKAGES_NOT_FOUND``
+# only those packages which have not been found which have the type RECOMMENDED
+# ``REQUIRED_PACKAGES_FOUND``
+# only those packages which have been found which have the type REQUIRED
+# ``REQUIRED_PACKAGES_NOT_FOUND``
+# only those packages which have not been found which have the type REQUIRED
+# ``RUNTIME_PACKAGES_FOUND``
+# only those packages which have been found which have the type RUNTIME
+# ``RUNTIME_PACKAGES_NOT_FOUND``
+# only those packages which have not been found which have the type RUNTIME
#
# With the exception of the ``ALL`` value, these values can be combined
# in order to customize the output. For example:
@@ -118,10 +129,11 @@
#
# ::
#
-# SET_PACKAGE_PROPERTIES(<name> PROPERTIES [ URL <url> ]
-# [ DESCRIPTION <description> ]
-# [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ]
-# [ PURPOSE <purpose> ]
+# SET_PACKAGE_PROPERTIES(<name> PROPERTIES
+# [ URL <url> ]
+# [ DESCRIPTION <description> ]
+# [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ]
+# [ PURPOSE <purpose> ]
# )
#
#
@@ -171,26 +183,30 @@
# ::
#
# find_package(LibXml2)
-# set_package_properties(LibXml2 PROPERTIES DESCRIPTION "A XML processing library."
-# URL "http://xmlsoft.org/")
+# set_package_properties(LibXml2 PROPERTIES
+# DESCRIPTION "A XML processing library."
+# URL "http://xmlsoft.org/")
#
#
#
# ::
#
-# set_package_properties(LibXml2 PROPERTIES TYPE RECOMMENDED
-# PURPOSE "Enables HTML-import in MyWordProcessor")
+# set_package_properties(LibXml2 PROPERTIES
+# TYPE RECOMMENDED
+# PURPOSE "Enables HTML-import in MyWordProcessor")
# ...
-# set_package_properties(LibXml2 PROPERTIES TYPE OPTIONAL
-# PURPOSE "Enables odt-export in MyWordProcessor")
+# set_package_properties(LibXml2 PROPERTIES
+# TYPE OPTIONAL
+# PURPOSE "Enables odt-export in MyWordProcessor")
#
#
#
# ::
#
# find_package(DBUS)
-# set_package_properties(DBUS PROPERTIES TYPE RUNTIME
-# PURPOSE "Necessary to disable the screensaver during a presentation" )
+# set_package_properties(DBUS PROPERTIES
+# TYPE RUNTIME
+# PURPOSE "Necessary to disable the screensaver during a presentation" )
#
#
#