Merge branch 'release-doc-formatting' into release

13 files changed, 102 insertions, 140 deletions

diff --git a/Modules/CPackNSIS.cmake b/Modules/CPackNSIS.cmake
index 9d23ec0..4b2e0eb 100644
--- a/Modules/CPackNSIS.cmake
+++ b/Modules/CPackNSIS.cmake
@@ -114,8 +114,8 @@
 #  installation prefix.  Like::
 #
 #   set(CPACK_NSIS_MENU_LINKS
-#       "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help"
-#       "http://www.cmake.org" "CMake Web Site")
+#       "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html"
+#       "CMake Help" "http://www.cmake.org" "CMake Web Site")
 #
 
 #=============================================================================
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake
index d6a6b72..1e9a98a 100644
--- a/Modules/ExternalProject.cmake
+++ b/Modules/ExternalProject.cmake
@@ -52,7 +52,7 @@
 #    [CMAKE_GENERATOR_PLATFORM p] # Generator-specific platform name
 #    [CMAKE_GENERATOR_TOOLSET t] # Generator-specific toolset name
 #    [CMAKE_ARGS args...]        # Arguments to CMake command line
-#    [CMAKE_CACHE_ARGS args...]  # Initial cache arguments, of the form -Dvar:string=on
+#    [CMAKE_CACHE_ARGS args...]  # Initial cache args with form -Dvar:string=on
 #   #--Build step-----------------
 #    [BINARY_DIR dir]            # Specify build dir location
 #    [BUILD_COMMAND cmd...]      # Command to drive the native build
diff --git a/Modules/FeatureSummary.cmake b/Modules/FeatureSummary.cmake
index 37bc6b5..9016db8 100644
--- a/Modules/FeatureSummary.cmake
+++ b/Modules/FeatureSummary.cmake
@@ -17,7 +17,7 @@
 # ::
 #
 #     -- The following OPTIONAL packages have been found:
-#     LibXml2 (required version >= 2.4) , XML processing library. , <http://xmlsoft.org>
+#     LibXml2 (required version >= 2.4), XML processing lib, <http://xmlsoft.org>
 #        * Enables HTML-import in MyWordProcessor
 #        * Enables odt-export in MyWordProcessor
 #     PNG , A PNG image library. , <http://www.libpng.org/pub/png/>
diff --git a/Modules/FindCUDA.cmake b/Modules/FindCUDA.cmake
index 3dd975c..29bb875 100644
--- a/Modules/FindCUDA.cmake
+++ b/Modules/FindCUDA.cmake
@@ -278,13 +278,13 @@
 #                            Only available for CUDA version 3.2+.
 #   CUDA_cusparse_LIBRARY -- CUDA Sparse Matrix library.
 #                            Only available for CUDA version 3.2+.
-#   CUDA_npp_LIBRARY      -- NVIDIA Performance Primitives library.
+#   CUDA_npp_LIBRARY      -- NVIDIA Performance Primitives lib.
 #                            Only available for CUDA version 4.0+.
-#   CUDA_nppc_LIBRARY      -- NVIDIA Performance Primitives library (core).
+#   CUDA_nppc_LIBRARY     -- NVIDIA Performance Primitives lib (core).
 #                            Only available for CUDA version 5.5+.
-#   CUDA_nppi_LIBRARY      -- NVIDIA Performance Primitives library (image processing).
+#   CUDA_nppi_LIBRARY     -- NVIDIA Performance Primitives lib (image processing).
 #                            Only available for CUDA version 5.5+.
-#   CUDA_npps_LIBRARY      -- NVIDIA Performance Primitives library (signal processing).
+#   CUDA_npps_LIBRARY     -- NVIDIA Performance Primitives lib (signal processing).
 #                            Only available for CUDA version 5.5+.
 #   CUDA_nvcuvenc_LIBRARY -- CUDA Video Encoder library.
 #                            Only available for CUDA version 3.2+.
diff --git a/Modules/FindGettext.cmake b/Modules/FindGettext.cmake
index 16478cb..f972ad0 100644
--- a/Modules/FindGettext.cmake
+++ b/Modules/FindGettext.cmake
@@ -17,6 +17,7 @@
 #
 #
 # Additionally it provides the following macros:
+#
 # GETTEXT_CREATE_TRANSLATIONS ( outputFile [ALL] file1 ...  fileN )
 #
 # ::
@@ -32,8 +33,9 @@
 # ::
 #
 #      Process the given pot file to mo files.
-#      If INSTALL_DESTINATION is given then automatically install rules will be created,
-#      the language subdirectory will be taken into account (by default use share/locale/).
+#      If INSTALL_DESTINATION is given then automatically install rules will
+#      be created, the language subdirectory will be taken into account
+#      (by default use share/locale/).
 #      If ALL is specified, the pot file is processed when building the all traget.
 #      It creates a custom target "potfile".
 #
@@ -43,8 +45,9 @@
 # ::
 #
 #      Process the given po files to mo files for the given language.
-#      If INSTALL_DESTINATION is given then automatically install rules will be created,
-#      the language subdirectory will be taken into account (by default use share/locale/).
+#      If INSTALL_DESTINATION is given then automatically install rules will
+#      be created, the language subdirectory will be taken into account
+#      (by default use share/locale/).
 #      If ALL is specified, the po files are processed when building the all traget.
 #      It creates a custom target "pofiles".
 
diff --git a/Modules/FindJava.cmake b/Modules/FindJava.cmake
index 0bd7eb0..79be34e 100644
--- a/Modules/FindJava.cmake
+++ b/Modules/FindJava.cmake
@@ -17,7 +17,7 @@
 #   Java_JAVAH_EXECUTABLE   = the full path to the Java header generator
 #   Java_JAVADOC_EXECUTABLE = the full path to the Java documention generator
 #   Java_JAR_EXECUTABLE     = the full path to the Java archiver
-#   Java_VERSION_STRING     = Version of the package found (java version), eg. 1.6.0_12
+#   Java_VERSION_STRING     = Version of java found, eg. 1.6.0_12
 #   Java_VERSION_MAJOR      = The major version of the package found.
 #   Java_VERSION_MINOR      = The minor version of the package found.
 #   Java_VERSION_PATCH      = The patch version of the package found.
diff --git a/Modules/FindLibXslt.cmake b/Modules/FindLibXslt.cmake
index bf2f821..2416341 100644
--- a/Modules/FindLibXslt.cmake
+++ b/Modules/FindLibXslt.cmake
@@ -17,10 +17,10 @@
 # Additionally, the following two variables are set (but not required
 # for using xslt):
 #
-# ::
-#
-#   LIBXSLT_EXSLT_LIBRARIES - Link to these if you need to link against the exslt library
-#   LIBXSLT_XSLTPROC_EXECUTABLE - Contains the full path to the xsltproc executable if found
+# ``LIBXSLT_EXSLT_LIBRARIES``
+#   Link to these if you need to link against the exslt library.
+# ``LIBXSLT_XSLTPROC_EXECUTABLE``
+#   Contains the full path to the xsltproc executable if found.
 
 #=============================================================================
 # Copyright 2006-2009 Kitware, Inc.
diff --git a/Modules/FindPkgConfig.cmake b/Modules/FindPkgConfig.cmake
index d728324..bf58ede 100644
--- a/Modules/FindPkgConfig.cmake
+++ b/Modules/FindPkgConfig.cmake
@@ -490,9 +490,10 @@ endmacro()
 
     pkg_check_modules (XRENDER REQUIRED xrender)
 
- Defines e.g.:
- ``XRENDER_LIBRARIES=Xrender;X11`` and
- ``XRENDER_STATIC_LIBRARIES=Xrender;X11;pthread;Xau;Xdmcp``
+ Defines for example::
+
+   XRENDER_LIBRARIES=Xrender;X11``
+   XRENDER_STATIC_LIBRARIES=Xrender;X11;pthread;Xau;Xdmcp
 #]========================================]
 macro(pkg_check_modules _prefix _module0)
   # check cached value
diff --git a/Modules/FindProtobuf.cmake b/Modules/FindProtobuf.cmake
index 72ca6ed..f01bd41 100644
--- a/Modules/FindProtobuf.cmake
+++ b/Modules/FindProtobuf.cmake
@@ -2,127 +2,80 @@
 # FindProtobuf
 # ------------
 #
-#
-#
 # Locate and configure the Google Protocol Buffers library.
 #
 # The following variables can be set and are optional:
 #
-# ::
-#
-#    PROTOBUF_SRC_ROOT_FOLDER - When compiling with MSVC, if this cache variable is set
-#                               the protobuf-default VS project build locations
-#                               (vsprojects/Debug & vsprojects/Release) will be searched
-#                               for libraries and binaries.
-#
-#
-#
-# ::
-#
-#    PROTOBUF_IMPORT_DIRS     - List of additional directories to be searched for
-#                               imported .proto files. (New in CMake 2.8.8)
-#
-#
+# ``PROTOBUF_SRC_ROOT_FOLDER``
+#   When compiling with MSVC, if this cache variable is set
+#   the protobuf-default VS project build locations
+#   (vsprojects/Debug & vsprojects/Release) will be searched
+#   for libraries and binaries.
+# ``PROTOBUF_IMPORT_DIRS``
+#   List of additional directories to be searched for
+#   imported .proto files.
 #
 # Defines the following variables:
 #
-# ::
-#
-#    PROTOBUF_FOUND - Found the Google Protocol Buffers library (libprotobuf & header files)
-#    PROTOBUF_INCLUDE_DIRS - Include directories for Google Protocol Buffers
-#    PROTOBUF_LIBRARIES - The protobuf libraries
-#
-# [New in CMake 2.8.5]
-#
-# ::
-#
-#    PROTOBUF_PROTOC_LIBRARIES - The protoc libraries
-#    PROTOBUF_LITE_LIBRARIES - The protobuf-lite libraries
-#
-#
+# ``PROTOBUF_FOUND``
+#   Found the Google Protocol Buffers library
+#   (libprotobuf & header files)
+# ``PROTOBUF_INCLUDE_DIRS``
+#   Include directories for Google Protocol Buffers
+# ``PROTOBUF_LIBRARIES``
+#   The protobuf libraries
+# ``PROTOBUF_PROTOC_LIBRARIES``
+#   The protoc libraries
+# ``PROTOBUF_LITE_LIBRARIES``
+#   The protobuf-lite libraries
 #
 # The following cache variables are also available to set or use:
 #
-# ::
-#
-#    PROTOBUF_LIBRARY - The protobuf library
-#    PROTOBUF_PROTOC_LIBRARY   - The protoc library
-#    PROTOBUF_INCLUDE_DIR - The include directory for protocol buffers
-#    PROTOBUF_PROTOC_EXECUTABLE - The protoc compiler
-#
-# [New in CMake 2.8.5]
-#
-# ::
-#
-#    PROTOBUF_LIBRARY_DEBUG - The protobuf library (debug)
-#    PROTOBUF_PROTOC_LIBRARY_DEBUG   - The protoc library (debug)
-#    PROTOBUF_LITE_LIBRARY - The protobuf lite library
-#    PROTOBUF_LITE_LIBRARY_DEBUG - The protobuf lite library (debug)
-#
-#
-#
-# ::
-#
-#   ====================================================================
-#   Example:
-#
-#
-#
-# ::
-#
-#    find_package(Protobuf REQUIRED)
-#    include_directories(${PROTOBUF_INCLUDE_DIRS})
-#
-#
-#
-# ::
-#
-#    include_directories(${CMAKE_CURRENT_BINARY_DIR})
-#    PROTOBUF_GENERATE_CPP(PROTO_SRCS PROTO_HDRS foo.proto)
-#    add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS})
-#    target_link_libraries(bar ${PROTOBUF_LIBRARIES})
-#
-#
-#
-# NOTE: You may need to link against pthreads, depending
-#
-# ::
-#
-#        on the platform.
-#
-#
-#
-# NOTE: The PROTOBUF_GENERATE_CPP macro & add_executable() or
-# add_library()
-#
-# ::
-#
-#        calls only work properly within the same directory.
-#
-#
-#
-# ::
-#
-#   ====================================================================
-#
-#
-#
-# PROTOBUF_GENERATE_CPP (public function)
-#
-# ::
-#
-#    SRCS = Variable to define with autogenerated
-#           source files
-#    HDRS = Variable to define with autogenerated
-#           header files
-#    ARGN = proto files
-#
-#
-#
-# ::
-#
-#   ====================================================================
-
+# ``PROTOBUF_LIBRARY``
+#   The protobuf library
+# ``PROTOBUF_PROTOC_LIBRARY``
+#   The protoc library
+# ``PROTOBUF_INCLUDE_DIR``
+#   The include directory for protocol buffers
+# ``PROTOBUF_PROTOC_EXECUTABLE``
+#   The protoc compiler
+# ``PROTOBUF_LIBRARY_DEBUG``
+#   The protobuf library (debug)
+# ``PROTOBUF_PROTOC_LIBRARY_DEBUG``
+#   The protoc library (debug)
+# ``PROTOBUF_LITE_LIBRARY``
+#   The protobuf lite library
+# ``PROTOBUF_LITE_LIBRARY_DEBUG``
+#   The protobuf lite library (debug)
+#
+# Example:
+#
+# .. code-block:: cmake
+#
+#   find_package(Protobuf REQUIRED)
+#   include_directories(${PROTOBUF_INCLUDE_DIRS})
+#   include_directories(${CMAKE_CURRENT_BINARY_DIR})
+#   protobuf_generate_cpp(PROTO_SRCS PROTO_HDRS foo.proto)
+#   add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS})
+#   target_link_libraries(bar ${PROTOBUF_LIBRARIES})
+#
+# .. note::
+#   The PROTOBUF_GENERATE_CPP macro and add_executable() or
+#   add_library() calls only work properly within the same
+#   directory.
+#
+# .. command:: protobuf_generate_cpp
+#
+#   Add custom commands to process ``.proto`` files::
+#
+#     protobuf_generate_cpp (<SRCS> <HDRS> [<ARGN>...])
+#
+#   ``SRCS``
+#     Variable to define with autogenerated source files
+#   ``HDRS``
+#     Variable to define with autogenerated header files
+#   ``ARGN``
+#     ``.proto`` files
 
 #=============================================================================
 # Copyright 2009 Kitware, Inc.
diff --git a/Modules/FindQt4.cmake b/Modules/FindQt4.cmake
index 2c39de5..c715c81 100644
--- a/Modules/FindQt4.cmake
+++ b/Modules/FindQt4.cmake
@@ -104,9 +104,11 @@
 #   macro QT4_ADD_DBUS_INTERFACES(outfiles inputfile ... )
 #         Create the interface header and implementation files
 #         for all listed interface xml files.
-#         The basename will be automatically determined from the name of the xml file.
+#         The basename will be automatically determined from the name
+#         of the xml file.
 #
-#         The source file properties described for QT4_ADD_DBUS_INTERFACE also apply here.
+#         The source file properties described for
+#         QT4_ADD_DBUS_INTERFACE also apply here.
 #
 #
 # ::
@@ -172,7 +174,7 @@
 #         a class uses the Q_OBJECT macro, moc has to run on it. If you don't
 #         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
+#         in foo.cpp and then give foo.cpp as argument to QT4_AUTOMOC(). This will
 #         scan all listed files at cmake-time for such included moc files and if it
 #         finds them cause a rule to be generated to run moc at build time on the
 #         accompanying header file foo.h.
@@ -188,8 +190,8 @@
 #         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.
+#         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)
diff --git a/Modules/FindSDL_image.cmake b/Modules/FindSDL_image.cmake
index fc2c043..49b5e40 100644
--- a/Modules/FindSDL_image.cmake
+++ b/Modules/FindSDL_image.cmake
@@ -11,7 +11,8 @@
 #   SDL_IMAGE_LIBRARIES, the name of the library to link against
 #   SDL_IMAGE_INCLUDE_DIRS, where to find the headers
 #   SDL_IMAGE_FOUND, if false, do not try to link against
-#   SDL_IMAGE_VERSION_STRING - human-readable string containing the version of SDL_image
+#   SDL_IMAGE_VERSION_STRING - human-readable string containing the
+#                              version of SDL_image
 #
 #
 #
diff --git a/Modules/FindSDL_mixer.cmake b/Modules/FindSDL_mixer.cmake
index 176fee6..9e11796 100644
--- a/Modules/FindSDL_mixer.cmake
+++ b/Modules/FindSDL_mixer.cmake
@@ -11,7 +11,8 @@
 #   SDL_MIXER_LIBRARIES, the name of the library to link against
 #   SDL_MIXER_INCLUDE_DIRS, where to find the headers
 #   SDL_MIXER_FOUND, if false, do not try to link against
-#   SDL_MIXER_VERSION_STRING - human-readable string containing the version of SDL_mixer
+#   SDL_MIXER_VERSION_STRING - human-readable string containing the
+#                              version of SDL_mixer
 #
 #
 #
diff --git a/Modules/FindSquish.cmake b/Modules/FindSquish.cmake
index 4fdecb4..51e279d 100644
--- a/Modules/FindSquish.cmake
+++ b/Modules/FindSquish.cmake
@@ -41,8 +41,9 @@
 #
 # ::
 #
-#    squish_v4_add_test(cmakeTestName AUT targetName SUITE suiteName TEST squishTestName
-#                    [SETTINGSGROUP group] [PRE_COMMAND command] [POST_COMMAND command] )
+#    squish_v4_add_test(cmakeTestName
+#      AUT targetName SUITE suiteName TEST squishTestName
+#      [SETTINGSGROUP group] [PRE_COMMAND command] [POST_COMMAND command] )
 #
 #
 #