Merge topic 'doc-line-lengths'

80b19a71 Help/manual: Avoid long lines in code blocks
4fdacedc Help: Clarify formatting of CPACK_WIX_ACL documentation
35ca4863 Help: Wrap long ctest_submit signature line
58b2d760 Modules: Format documentation to avoid over-long preformatted lines

Help/command/ctest_submit.rst

@@ -5,7 +5,11 @@ Submit results to a dashboard server.
 
 ::
 
-  ctest_submit([PARTS ...] [FILES ...] [RETRY_COUNT count]                [RETRY_DELAY delay][RETURN_VALUE res])
+  ctest_submit([PARTS ...] [FILES ...]
+               [RETRY_COUNT count]
+               [RETRY_DELAY delay]
+               [RETURN_VALUE res]
+               )
 
 By default all available parts are submitted if no PARTS or FILES are
 specified.  The PARTS option lists a subset of parts to be submitted.

Help/manual/cmake-compile-features.7.rst

@@ -276,10 +276,13 @@ properties:
 .. code-block:: cmake
 
   add_library(foo INTERFACE)
+  set(with_variadics ${CMAKE_CURRENT_SOURCE_DIR}/with_variadics)
+  set(no_variadics ${CMAKE_CURRENT_SOURCE_DIR}/no_variadics)
   target_link_libraries(foo
     INTERFACE
-      "$<$<COMPILE_FEATURES:cxx_variadic_templates>:${CMAKE_CURRENT_SOURCE_DIR}/with_variadics>"
+      "$<$<COMPILE_FEATURES:cxx_variadic_templates>:${with_variadics}>"
-      "$<$<NOT:$<COMPILE_FEATURES:cxx_variadic_templates>>:${CMAKE_CURRENT_SOURCE_DIR}/no_variadics>")
+      "$<$<NOT:$<COMPILE_FEATURES:cxx_variadic_templates>>:${no_variadics}>"
+    )
 
 Consuming code then simply links to the ``foo`` target as usual and uses
 the feature-appropriate include directory

Help/manual/cmake-developer.7.rst

@@ -1005,7 +1005,8 @@ projects that do not require a high enough CMake version.
 .. code-block:: cmake
 
   if(CMAKE_MINIMUM_REQUIRED_VERSION VERSION_LESS 3.0.0)
-    message(AUTHOR_WARNING "Your project should require at least CMake 3.0.0 to use FindFoo.cmake")
+    message(AUTHOR_WARNING
+      "Your project should require at least CMake 3.0.0 to use FindFoo.cmake")
   endif()
 
 Now the actual libraries and so on have to be found.  The code here will

Help/manual/cmake-generator-expressions.7.rst

@@ -38,6 +38,8 @@ create conditional output::
 expands to ``DEBUG_MODE`` when the ``Debug`` configuration is used, and
 otherwise expands to nothing.
 
+Available logical expressions are:
+
 ``$<0:...>``
   Empty string (ignores ``...``)
 ``$<1:...>``
@@ -111,6 +113,8 @@ expands to ``OLD_COMPILER`` if the
 :variable:`CMAKE_CXX_COMPILER_VERSION <CMAKE_<LANG>_COMPILER_VERSION>` is less
 than 4.2.0.
 
+Available informational expressions are:
+
 ``$<CONFIGURATION>``
   Configuration name. Deprecated. Use ``CONFIG`` instead.
 ``$<CONFIG>``
@@ -185,7 +189,13 @@ property with each entry preceeded by ``-I``. Note that a more-complete use
 in this situation would require first checking if the INCLUDE_DIRECTORIES
 property is non-empty::
 
-  $<$<BOOL:$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>>:-I$<JOIN:$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>, -I>>
+  $<$<BOOL:${prop}>:-I$<JOIN:${prop}, -I>>
+
+where ``${prop}`` refers to a helper variable::
+
+  set(prop "$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>")
+
+Available output expressions are:
 
 ``$<JOIN:list,...>``
   Joins the list with the content of ``...``

Help/manual/cmake-toolchains.7.rst

@@ -115,8 +115,9 @@ as:
   set(CMAKE_SYSROOT /home/devel/rasp-pi-rootfs)
   set(CMAKE_STAGING_PREFIX /home/devel/stage)
 
-  set(CMAKE_C_COMPILER /home/devel/gcc-4.7-linaro-rpi-gnueabihf/bin/arm-linux-gnueabihf-gcc)
+  set(tools /home/devel/gcc-4.7-linaro-rpi-gnueabihf)
-  set(CMAKE_CXX_COMPILER /home/devel/gcc-4.7-linaro-rpi-gnueabihf/bin/arm-linux-gnueabihf-g++)
+  set(CMAKE_C_COMPILER ${tools}/bin/arm-linux-gnueabihf-gcc)
+  set(CMAKE_CXX_COMPILER ${tools}/bin/arm-linux-gnueabihf-g++)
 
   set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
   set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)

Help/prop_inst/CPACK_WIX_ACL.rst

@@ -14,5 +14,6 @@ each of which has to match the following format.
 ``<user>`` and ``<domain>`` specify the windows user and domain for which the
 ``<Permission>`` element should be generated.
 
-``<permission>`` is any of the YesNoType attributes listed here:
+``<permission>`` is any of the YesNoType attributes listed here::
-http://wixtoolset.org/documentation/manual/v3/xsd/wix/permission.html
+
+ http://wixtoolset.org/documentation/manual/v3/xsd/wix/permission.html

Modules/CMakeExpandImportedTargets.cmake

@@ -20,7 +20,8 @@
 #
 # ::
 #
-#     cmake_expand_imported_targets(expandedLibs LIBRARIES ${CMAKE_REQUIRED_LIBRARIES}
+#     cmake_expand_imported_targets(expandedLibs
+#       LIBRARIES ${CMAKE_REQUIRED_LIBRARIES}
 #       CONFIGURATION "${CMAKE_TRY_COMPILE_CONFIGURATION}" )
 
 

Modules/CMakeFindPackageMode.cmake

@@ -7,15 +7,24 @@
 # This file is executed by cmake when invoked with --find-package.  It
 # expects that the following variables are set using -D:
 #
-# ::
+# ``NAME``
-#
+#   name of the package
-#    NAME = name of the package
+# ``COMPILER_ID``
-#    COMPILER_ID = the CMake compiler ID for which the result is, i.e. GNU/Intel/Clang/MSVC, etc.
+#   the CMake compiler ID for which the result is,
-#    LANGUAGE = language for which the result will be used, i.e. C/CXX/Fortan/ASM
+#   i.e. GNU/Intel/Clang/MSVC, etc.
-#    MODE = EXIST : only check for existence of the given package
+# ``LANGUAGE``
-#           COMPILE : print the flags needed for compiling an object file which uses the given package
+#   language for which the result will be used,
-#           LINK : print the flags needed for linking when using the given package
+#   i.e. C/CXX/Fortan/ASM
-#    QUIET = if TRUE, don't print anything
+# ``MODE``
+#   ``EXIST``
+#     only check for existence of the given package
+#   ``COMPILE``
+#     print the flags needed for compiling an object file which uses
+#     the given package
+#   ``LINK``
+#     print the flags needed for linking when using the given package
+# ``QUIET``
+#   if TRUE, don't print anything
 
 #=============================================================================
 # Copyright 2006-2011 Alexander Neundorf, <neundorf@kde.org>

Modules/CMakePackageConfigHelpers.cmake

@@ -15,12 +15,13 @@
 #
 #  Create a config file for a project::
 #
-#     configure_package_config_file(<input> <output> INSTALL_DESTINATION <path>
+#    configure_package_config_file(<input> <output>
+#      INSTALL_DESTINATION <path>
 #      [PATH_VARS <var1> <var2> ... <varN>]
 #      [NO_SET_AND_CHECK_MACRO]
 #      [NO_CHECK_REQUIRED_COMPONENTS_MACRO]
-#                                                    [INSTALL_PREFIX <path>])
+#      [INSTALL_PREFIX <path>]
-#
+#      )
 #
 # ``configure_package_config_file()`` should be used instead of the plain
 # :command:`configure_file()` command when creating the ``<Name>Config.cmake``
@@ -172,13 +173,16 @@
 #    set(SYSCONFIG_INSTALL_DIR etc/foo/ ... CACHE )
 #    ...
 #    include(CMakePackageConfigHelpers)
-#    configure_package_config_file(FooConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake
+#    configure_package_config_file(FooConfig.cmake.in
+#      ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake
 #      INSTALL_DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake
 #      PATH_VARS INCLUDE_INSTALL_DIR SYSCONFIG_INSTALL_DIR)
-#    write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
+#    write_basic_package_version_file(
+#      ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
 #      VERSION 1.2.3
 #      COMPATIBILITY SameMajorVersion )
-#    install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
+#    install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake
+#                  ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
 #            DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake )
 #
 # ``FooConfig.cmake.in``:

Modules/CMakeParseArguments.cmake

@@ -45,7 +45,8 @@
 #      set(options OPTIONAL FAST)
 #      set(oneValueArgs DESTINATION RENAME)
 #      set(multiValueArgs TARGETS CONFIGURATIONS)
-#      cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
+#      cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}"
+#                            "${multiValueArgs}" ${ARGN} )
 #      ...
 #
 #

Modules/CMakePrintHelpers.cmake

@@ -15,11 +15,10 @@
 #
 # This macro prints the values of the properties of the given targets,
 # source files, directories, tests or cache entries.  Exactly one of the
-# scope keywords must be used.  Example:
+# scope keywords must be used.  Example::
 #
-# ::
+#    cmake_print_properties(TARGETS foo bar PROPERTIES
-#
+#                           LOCATION INTERFACE_INCLUDE_DIRS)
-#    cmake_print_properties(TARGETS foo bar PROPERTIES LOCATION INTERFACE_INCLUDE_DIRS)
 #
 # This will print the LOCATION and INTERFACE_INCLUDE_DIRS properties for
 # both targets foo and bar.
@@ -29,17 +28,13 @@
 # CMAKE_PRINT_VARIABLES(var1 var2 ..  varN)
 #
 # This macro will print the name of each variable followed by its value.
-# Example:
+# Example::
 #
-# ::
+#   cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION DOES_NOT_EXIST)
 #
-#    cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION THIS_ONE_DOES_NOT_EXIST)
+# Gives::
 #
-# Gives:
+#   -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; DOES_NOT_EXIST=""
-#
-# ::
-#
-#    -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; THIS_ONE_DOES_NOT_EXIST=""
 
 #=============================================================================
 # Copyright 2013 Alexander Neundorf, <neundorf@kde.org>

Modules/DeployQt4.cmake

@@ -37,7 +37,8 @@
 #
 # ::
 #
-#   FIXUP_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>])
+#   FIXUP_QT4_EXECUTABLE(<executable>
+#     [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>])
 #
 # Copies Qt plugins, writes a Qt configuration file (if needed) and
 # fixes up a Qt4 executable using BundleUtilities so it is standalone
@@ -63,7 +64,8 @@
 #
 # ::
 #
-#   INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var <plugins_dir> <component> <configurations>)
+#   INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var
+#                           <plugins_dir> <component> <configurations>)
 #
 # Install (or copy) a resolved <plugin> to the default plugins directory
 # (or <plugins_dir>) relative to <executable> and store the result in
@@ -77,7 +79,8 @@
 #
 # ::
 #
-#   INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var <plugins_dir> <component>)
+#   INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var
+#                      <plugins_dir> <component>)
 #
 # Install (or copy) an unresolved <plugin> to the default plugins
 # directory (or <plugins_dir>) relative to <executable> and store the
@@ -86,7 +89,8 @@
 #
 # ::
 #
-#   INSTALL_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>])
+#   INSTALL_QT4_EXECUTABLE(<executable>
+#     [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>])
 #
 # Installs Qt plugins, writes a Qt configuration file (if needed) and
 # fixes up a Qt4 executable using BundleUtilities so it is standalone

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
-#     ALL: print everything
+# ``ENABLED_FEATURES``
-#     ENABLED_FEATURES: the list of all features which are enabled
+#  the list of all features which are enabled
-#     DISABLED_FEATURES: the list of all features which are disabled
+# ``DISABLED_FEATURES``
-#     PACKAGES_FOUND: the list of all packages which have been found
+#  the list of all features which are disabled
-#     PACKAGES_NOT_FOUND: the list of all packages which have not been found
+# ``PACKAGES_FOUND``
-#     OPTIONAL_PACKAGES_FOUND: only those packages which have been found which have the type OPTIONAL
+#  the list of all packages which have been found
-#     OPTIONAL_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type OPTIONAL
+# ``PACKAGES_NOT_FOUND``
-#     RECOMMENDED_PACKAGES_FOUND: only those packages which have been found which have the type RECOMMENDED
+#  the list of all packages which have not been found
-#     RECOMMENDED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RECOMMENDED
+# ``OPTIONAL_PACKAGES_FOUND``
-#     REQUIRED_PACKAGES_FOUND: only those packages which have been found which have the type REQUIRED
+#  only those packages which have been found which have the type OPTIONAL
-#     REQUIRED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type REQUIRED
+# ``OPTIONAL_PACKAGES_NOT_FOUND``
-#     RUNTIME_PACKAGES_FOUND: only those packages which have been found which have the type RUNTIME
+#  only those packages which have not been found which have the type OPTIONAL
-#     RUNTIME_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RUNTIME
+# ``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,7 +129,8 @@
 #
 # ::
 #
-#     SET_PACKAGE_PROPERTIES(<name> PROPERTIES [ URL <url> ]
+#     SET_PACKAGE_PROPERTIES(<name> PROPERTIES
+#                            [ URL <url> ]
 #                            [ DESCRIPTION <description> ]
 #                            [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ]
 #                            [ PURPOSE <purpose> ]
@@ -171,17 +183,20 @@
 # ::
 #
 #    find_package(LibXml2)
-#    set_package_properties(LibXml2 PROPERTIES DESCRIPTION "A XML processing library."
+#    set_package_properties(LibXml2 PROPERTIES
+#                           DESCRIPTION "A XML processing library."
 #                           URL "http://xmlsoft.org/")
 #
 #
 #
 # ::
 #
-#    set_package_properties(LibXml2 PROPERTIES TYPE RECOMMENDED
+#    set_package_properties(LibXml2 PROPERTIES
+#                           TYPE RECOMMENDED
 #                           PURPOSE "Enables HTML-import in MyWordProcessor")
 #    ...
-#    set_package_properties(LibXml2 PROPERTIES TYPE OPTIONAL
+#    set_package_properties(LibXml2 PROPERTIES
+#                           TYPE OPTIONAL
 #                           PURPOSE "Enables odt-export in MyWordProcessor")
 #
 #
@@ -189,7 +204,8 @@
 # ::
 #
 #    find_package(DBUS)
-#    set_package_properties(DBUS PROPERTIES TYPE RUNTIME
+#    set_package_properties(DBUS PROPERTIES
+#      TYPE RUNTIME
 #      PURPOSE "Necessary to disable the screensaver during a presentation" )
 #
 #

Modules/FindBacktrace.cmake

@@ -5,18 +5,24 @@
 # Find provider for backtrace(3).
 #
 # Checks if OS supports backtrace(3) via either libc or custom library.
-# This module defines the following variables::
+# This module defines the following variables:
 #
-#  Backtrace_HEADER       - The header file needed for backtrace(3). Cached.
+# ``Backtrace_HEADER``
+#   The header file needed for backtrace(3). Cached.
 #   Could be forcibly set by user.
-#  Backtrace_INCLUDE_DIRS - The include directories needed to use backtrace(3) header.
+# ``Backtrace_INCLUDE_DIRS``
-#  Backtrace_LIBRARIES    - The libraries (linker flags) needed to use backtrace(3), if any.
+#   The include directories needed to use backtrace(3) header.
-#  Backtrace_FOUND        - Is set if and only if backtrace(3) support detected.
+# ``Backtrace_LIBRARIES``
+#   The libraries (linker flags) needed to use backtrace(3), if any.
+# ``Backtrace_FOUND``
+#   Is set if and only if backtrace(3) support detected.
 #
-# The following cache variables are also available to set or use::
+# The following cache variables are also available to set or use:
 #
-#  Backtrace_LIBRARY     - The external library providing backtrace, if any.
+# ``Backtrace_LIBRARY``
-#  Backtrace_INCLUDE_DIR - The directory holding the backtrace(3) header.
+#   The external library providing backtrace, if any.
+# ``Backtrace_INCLUDE_DIR``
+#   The directory holding the backtrace(3) header.
 #
 # Typical usage is to generate of header file using configure_file() with the
 # contents like the following::

Modules/FindKDE3.cmake

@@ -8,29 +8,29 @@
 #
 # This module defines the following variables:
 #
-# ::
+# ``KDE3_DEFINITIONS``
-#
+#   compiler definitions required for compiling KDE software
-#   KDE3_DEFINITIONS         - compiler definitions required for compiling KDE software
+# ``KDE3_INCLUDE_DIR``
-#   KDE3_INCLUDE_DIR         - the KDE include directory
+#   the KDE include directory
-#   KDE3_INCLUDE_DIRS        - the KDE and the Qt include directory, for use with include_directories()
+# ``KDE3_INCLUDE_DIRS``
-#   KDE3_LIB_DIR             - the directory where the KDE libraries are installed, for use with link_directories()
+#   the KDE and the Qt include directory, for use with include_directories()
-#   QT_AND_KDECORE_LIBS      - this contains both the Qt and the kdecore library
+# ``KDE3_LIB_DIR``
-#   KDE3_DCOPIDL_EXECUTABLE  - the dcopidl executable
+#   the directory where the KDE libraries are installed, for use with link_directories()
-#   KDE3_DCOPIDL2CPP_EXECUTABLE - the dcopidl2cpp executable
+# ``QT_AND_KDECORE_LIBS``
-#   KDE3_KCFGC_EXECUTABLE    - the kconfig_compiler executable
+#   this contains both the Qt and the kdecore library
-#   KDE3_FOUND               - set to TRUE if all of the above has been found
+# ``KDE3_DCOPIDL_EXECUTABLE``
-#
+#   the dcopidl executable
-#
+# ``KDE3_DCOPIDL2CPP_EXECUTABLE``
+#   the dcopidl2cpp executable
+# ``KDE3_KCFGC_EXECUTABLE``
+#   the kconfig_compiler executable
+# ``KDE3_FOUND``
+#   set to TRUE if all of the above has been found
 #
 # The following user adjustable options are provided:
 #
-# ::
+# ``KDE3_BUILD_TESTS``
-#
+#   enable this to build KDE testcases
-#   KDE3_BUILD_TESTS - enable this to build KDE testcases
-#
-#
-#
-#
 #
 # It also adds the following macros (from KDE3Macros.cmake) SRCS_VAR is
 # always the variable which contains the list of source files for your
@@ -101,7 +101,8 @@
 #
 # ::
 #
-#     Currently identical to add_executable(), may provide some advanced features in the future.
+#     Currently identical to add_executable(), may provide some advanced
+#     features in the future.
 #
 #
 #
@@ -110,7 +111,8 @@
 # ::
 #
 #     Create a KDE plugin (KPart, kioslave, etc.) from the given source files.
-#     If WITH_PREFIX is given, the resulting plugin will have the prefix "lib", otherwise it won't.
+#     If WITH_PREFIX is given, the resulting plugin will have the prefix "lib",
+#     otherwise it won't.
 #     It creates and installs an appropriate libtool la-file.
 #
 #
@@ -120,7 +122,8 @@
 # ::
 #
 #     Create a KDE application in the form of a module loadable via kdeinit.
-#     A library named kdeinit_<name> will be created and a small executable which links to it.
+#     A library named kdeinit_<name> will be created and a small executable
+#     which links to it.
 #
 #
 #

Modules/FindOpenSceneGraph.cmake

@@ -40,13 +40,14 @@
 # OSG and it's various components.  CMAKE_PREFIX_PATH can also be used
 # for this (see find_library() CMake documentation).
 #
-# ::
+# ``<MODULE>_DIR``
-#
+#   (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file)
-#     <MODULE>_DIR (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file)
+# ``OSG_DIR``
-#     OSG_DIR
+#   ..
-#     OSGDIR
+# ``OSGDIR``
-#     OSG_ROOT
+#   ..
-#
+# ``OSG_ROOT``
+#   ..
 #
 #
 # [CMake 2.8.10]: The CMake variable OSG_DIR can now be used as well to

Modules/FindPNG.cmake

@@ -10,19 +10,22 @@
 #
 # It defines the following variables
 #
-# ::
+# ``PNG_INCLUDE_DIRS``
-#
+#   where to find png.h, etc.
-#   PNG_INCLUDE_DIRS, where to find png.h, etc.
+# ``PNG_LIBRARIES``
-#   PNG_LIBRARIES, the libraries to link against to use PNG.
+#   the libraries to link against to use PNG.
-#   PNG_DEFINITIONS - You should add_definitons(${PNG_DEFINITIONS}) before compiling code that includes png library files.
+# ``PNG_DEFINITIONS``
-#   PNG_FOUND, If false, do not try to use PNG.
+#   You should add_definitons(${PNG_DEFINITIONS}) before compiling code
-#   PNG_VERSION_STRING - the version of the PNG library found (since CMake 2.8.8)
+#   that includes png library files.
+# ``PNG_FOUND``
+#   If false, do not try to use PNG.
+# ``PNG_VERSION_STRING``
+#   the version of the PNG library found (since CMake 2.8.8)
 #
 # Also defined, but not for general use are
 #
-# ::
+# ``PNG_LIBRARY``
-#
+#   where to find the PNG library.
-#   PNG_LIBRARY, where to find the PNG library.
 #
 # For backward compatiblity the variable PNG_INCLUDE_DIR is also set.
 # It has the same value as PNG_INCLUDE_DIRS.

Modules/FindPackageHandleStandardArgs.cmake

@@ -20,7 +20,8 @@
 #
 # ::
 #
-#     FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name> (DEFAULT_MSG|"Custom failure message") <var1>...<varN> )
+#     FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name>
+#       (DEFAULT_MSG|"Custom failure message") <var1>...<varN> )
 #
 # If the variables <var1> to <varN> are all valid, then
 # <UPPERCASED_NAME>_FOUND will be set to TRUE.  If DEFAULT_MSG is given
@@ -32,15 +33,14 @@
 #
 # ::
 #
-#     FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME [FOUND_VAR <resultVar>]
+#     FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME
+#       [FOUND_VAR <resultVar>]
 #       [REQUIRED_VARS <var1>...<varN>]
 #       [VERSION_VAR   <versionvar>]
 #       [HANDLE_COMPONENTS]
 #       [CONFIG_MODE]
 #       [FAIL_MESSAGE "Custom failure message"] )
 #
-#
-#
 # In this mode, the name of the result-variable can be set either to
 # either <UPPERCASED_NAME>_FOUND or <OriginalCase_Name>_FOUND using the
 # FOUND_VAR option.  Other names for the result-variable are not
@@ -75,7 +75,8 @@
 #
 # ::
 #
-#     find_package_handle_standard_args(LibXml2  DEFAULT_MSG  LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR)
+#     find_package_handle_standard_args(LibXml2  DEFAULT_MSG
+#       LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR)
 #
 #
 #
@@ -90,7 +91,8 @@
 #
 # ::
 #
-#     find_package_handle_standard_args(LibXslt FOUND_VAR LibXslt_FOUND
+#     find_package_handle_standard_args(LibXslt
+#       FOUND_VAR LibXslt_FOUND
 #       REQUIRED_VARS LibXslt_LIBRARIES LibXslt_INCLUDE_DIRS
 #       VERSION_VAR LibXslt_VERSION_STRING)
 #

Modules/FindQt4.cmake

@@ -111,12 +111,14 @@
 #
 # ::
 #
-#   macro QT4_ADD_DBUS_ADAPTOR(outfiles xmlfile parentheader parentclassname [basename] [classname])
+#   macro QT4_ADD_DBUS_ADAPTOR(outfiles xmlfile parentheader parentclassname
+#                              [basename] [classname])
 #         create a dbus adaptor (header and implementation file) from the xml file
 #         describing the interface, and add it to the list of sources. The adaptor
 #         forwards the calls to a parent class, defined in parentheader and named
 #         parentclassname. The name of the generated files will be
-#         <basename>adaptor.{cpp,h} where basename defaults to the basename of the xml file.
+#         <basename>adaptor.{cpp,h} where basename defaults to the basename of the
+#         xml file.
 #         If <classname> is provided, then it will be used as the classname of the
 #         adaptor itself.
 #
@@ -128,7 +130,8 @@
 #         If the optional argument interfacename is omitted, the name of the
 #         interface file is constructed from the basename of the header with
 #         the suffix .xml appended.
-#         Options may be given to qdbuscpp2xml, such as those found when executing "qdbuscpp2xml --help"
+#         Options may be given to qdbuscpp2xml, such as those found when
+#         executing "qdbuscpp2xml --help"
 #
 #
 # ::
@@ -170,10 +173,11 @@
 #         want to use QT4_WRAP_CPP() (which is reliable and mature), you can insert
 #         #include "foo.moc"
 #         in foo.cpp and then give foo.cpp as argument to QT4_AUTOMOC(). This will the
-#         scan all listed files at cmake-time for such included moc files and if it finds
+#         scan all listed files at cmake-time for such included moc files and if it
-#         them cause a rule to be generated to run moc at build time on the
+#         finds them cause a rule to be generated to run moc at build time on the
 #         accompanying header file foo.h.
-#         If a source file has the SKIP_AUTOMOC property set it will be ignored by this macro.
+#         If a source file has the SKIP_AUTOMOC property set it will be ignored by
+#         this macro.
 #         If the <tgt> is specified, the INTERFACE_INCLUDE_DIRECTORIES and
 #         INTERFACE_COMPILE_DEFINITIONS from the <tgt> are passed to moc.
 #
@@ -181,16 +185,17 @@
 # ::
 #
 #  function QT4_USE_MODULES( target [link_type] modules...)
-#         This function is obsolete. Use target_link_libraries with IMPORTED targets instead.
+#         This function is obsolete. Use target_link_libraries with IMPORTED targets
+#         instead.
 #         Make <target> use the <modules> from Qt. Using a Qt module means
 #         to link to the library, add the relevant include directories for the module,
 #         and add the relevant compiler defines for using the module.
 #         Modules are roughly equivalent to components of Qt4, so usage would be
 #         something like:
 #          qt4_use_modules(myexe Core Gui Declarative)
-#         to use QtCore, QtGui and QtDeclarative. The optional <link_type> argument can
+#         to use QtCore, QtGui and QtDeclarative. The optional <link_type> argument
-#         be specified as either LINK_PUBLIC or LINK_PRIVATE to specify the same argument
+#         can be specified as either LINK_PUBLIC or LINK_PRIVATE to specify the
-#         to the target_link_libraries call.
+#         same argument to the target_link_libraries call.
 #
 #
 # IMPORTED Targets

Modules/FindRuby.cmake

@@ -14,19 +14,21 @@
 # It also determines what the name of the library is.  This code sets
 # the following variables:
 #
-# ::
+# ``RUBY_EXECUTABLE``
+#   full path to the ruby binary
+# ``RUBY_INCLUDE_DIRS``
+#   include dirs to be used when using the ruby library
+# ``RUBY_LIBRARY``
+#   full path to the ruby library
+# ``RUBY_VERSION``
+#   the version of ruby which was found, e.g. "1.8.7"
+# ``RUBY_FOUND``
+#   set to true if ruby ws found successfully
 #
-#   RUBY_EXECUTABLE   = full path to the ruby binary
+# Also:
-#   RUBY_INCLUDE_DIRS = include dirs to be used when using the ruby library
-#   RUBY_LIBRARY      = full path to the ruby library
-#   RUBY_VERSION      = the version of ruby which was found, e.g. "1.8.7"
-#   RUBY_FOUND        = set to true if ruby ws found successfully
 #
-#
+# ``RUBY_INCLUDE_PATH``
-#
+#   same as RUBY_INCLUDE_DIRS, only provided for compatibility reasons, don't use it
-# ::
-#
-#   RUBY_INCLUDE_PATH = same as RUBY_INCLUDE_DIRS, only provided for compatibility reasons, don't use it
 
 #=============================================================================
 # Copyright 2004-2009 Kitware, Inc.

Modules/FindSquish.cmake

@@ -21,7 +21,8 @@
 #
 # ::
 #
-#   SQUISH_INSTALL_DIR              The Squish installation directory (containing bin, lib, etc)
+#   SQUISH_INSTALL_DIR              The Squish installation directory
+#                                   (containing bin, lib, etc)
 #   SQUISH_SERVER_EXECUTABLE        The squishserver executable
 #   SQUISH_CLIENT_EXECUTABLE        The squishrunner executable
 #
@@ -47,21 +48,26 @@
 #
 # The arguments have the following meaning:
 #
-# ::
+# ``cmakeTestName``
-#
+#   this will be used as the first argument for add_test()
-#    cmakeTestName: this will be used as the first argument for add_test()
+# ``AUT targetName``
-#    AUT targetName: the name of the cmake target which will be used as AUT, i.e. the
+#   the name of the cmake target which will be used as AUT, i.e. the
 #   executable which will be tested.
-#    SUITE suiteName: this is either the full path to the squish suite, or just the
+# ``SUITE suiteName``
+#   this is either the full path to the squish suite, or just the
 #   last directory of the suite, i.e. the suite name. In this case
 #   the CMakeLists.txt which calls squish_add_test() must be located
 #   in the parent directory of the suite directory.
-#    TEST squishTestName: the name of the squish test, i.e. the name of the subdirectory
+# ``TEST squishTestName``
+#   the name of the squish test, i.e. the name of the subdirectory
 #   of the test inside the suite directory.
-#    SETTINGSGROUP group: if specified, the given settings group will be used for executing the test.
+# ``SETTINGSGROUP group``
+#   if specified, the given settings group will be used for executing the test.
 #   If not specified, the groupname will be "CTest_<username>"
-#    PRE_COMMAND command:  if specified, the given command will be executed before starting the squish test.
+# ``PRE_COMMAND command``
-#    POST_COMMAND command: same as PRE_COMMAND, but after the squish test has been executed.
+#   if specified, the given command will be executed before starting the squish test.
+# ``POST_COMMAND command``
+#   same as PRE_COMMAND, but after the squish test has been executed.
 #
 #
 #
@@ -70,7 +76,12 @@
 #    enable_testing()
 #    find_package(Squish 4.0)
 #    if (SQUISH_FOUND)
-#       squish_v4_add_test(myTestName AUT myApp SUITE ${CMAKE_SOURCE_DIR}/tests/mySuite TEST someSquishTest SETTINGSGROUP myGroup )
+#       squish_v4_add_test(myTestName
+#         AUT myApp
+#         SUITE ${CMAKE_SOURCE_DIR}/tests/mySuite
+#         TEST someSquishTest
+#         SETTINGSGROUP myGroup
+#         )
 #    endif ()
 #
 #

Modules/GNUInstallDirs.cmake

@@ -6,36 +6,47 @@
 #
 # Provides install directory variables as defined for GNU software:
 #
-# ::
-#
 #   http://www.gnu.org/prep/standards/html_node/Directory-Variables.html
 #
 # Inclusion of this module defines the following variables:
 #
-# ::
+# ``CMAKE_INSTALL_<dir>``
-#
+#   destination for files of a given type
-#   CMAKE_INSTALL_<dir>      - destination for files of a given type
+# ``CMAKE_INSTALL_FULL_<dir>``
-#   CMAKE_INSTALL_FULL_<dir> - corresponding absolute path
+#   corresponding absolute path
 #
 # where <dir> is one of:
 #
-# ::
+# ``BINDIR``
-#
+#   user executables (bin)
-#   BINDIR           - user executables (bin)
+# ``SBINDIR``
-#   SBINDIR          - system admin executables (sbin)
+#   system admin executables (sbin)
-#   LIBEXECDIR       - program executables (libexec)
+# ``LIBEXECDIR``
-#   SYSCONFDIR       - read-only single-machine data (etc)
+#   program executables (libexec)
-#   SHAREDSTATEDIR   - modifiable architecture-independent data (com)
+# ``SYSCONFDIR``
-#   LOCALSTATEDIR    - modifiable single-machine data (var)
+#   read-only single-machine data (etc)
-#   LIBDIR           - object code libraries (lib or lib64 or lib/<multiarch-tuple> on Debian)
+# ``SHAREDSTATEDIR``
-#   INCLUDEDIR       - C header files (include)
+#   modifiable architecture-independent data (com)
-#   OLDINCLUDEDIR    - C header files for non-gcc (/usr/include)
+# ``LOCALSTATEDIR``
-#   DATAROOTDIR      - read-only architecture-independent data root (share)
+#   modifiable single-machine data (var)
-#   DATADIR          - read-only architecture-independent data (DATAROOTDIR)
+# ``LIBDIR``
-#   INFODIR          - info documentation (DATAROOTDIR/info)
+#   object code libraries (lib or lib64 or lib/<multiarch-tuple> on Debian)
-#   LOCALEDIR        - locale-dependent data (DATAROOTDIR/locale)
+# ``INCLUDEDIR``
-#   MANDIR           - man documentation (DATAROOTDIR/man)
+#   C header files (include)
-#   DOCDIR           - documentation root (DATAROOTDIR/doc/PROJECT_NAME)
+# ``OLDINCLUDEDIR``
+#   C header files for non-gcc (/usr/include)
+# ``DATAROOTDIR``
+#   read-only architecture-independent data root (share)
+# ``DATADIR``
+#   read-only architecture-independent data (DATAROOTDIR)
+# ``INFODIR``
+#   info documentation (DATAROOTDIR/info)
+# ``LOCALEDIR``
+#   locale-dependent data (DATAROOTDIR/locale)
+# ``MANDIR``
+#   man documentation (DATAROOTDIR/man)
+# ``DOCDIR``
+#   documentation root (DATAROOTDIR/doc/PROJECT_NAME)
 #
 # Each CMAKE_INSTALL_<dir> value may be passed to the DESTINATION
 # options of install() commands for the corresponding file type.  If the

Modules/WriteBasicConfigVersionFile.cmake

@@ -6,7 +6,10 @@
 #
 # ::
 #
-#   WRITE_BASIC_CONFIG_VERSION_FILE( filename [VERSION major.minor.patch] COMPATIBILITY (AnyNewerVersion|SameMajorVersion) )
+#   WRITE_BASIC_CONFIG_VERSION_FILE( filename
+#     [VERSION major.minor.patch]
+#     COMPATIBILITY (AnyNewerVersion|SameMajorVersion)
+#     )
 #
 #
 #