kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Modules: Wrap long lines in pre-formatted documentation blocks 

Help format the blocks better for display without a wide screen.
This commit is contained in:
Brad King 2014-11-06 13:50:40 -05:00
parent 6c4aa388a5
commit 20c5f4fbd9
12 changed files with 38 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Modules/CPackNSIS.cmake
View File

@ -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")
#
#=============================================================================

2
Modules/ExternalProject.cmake
View File

@ -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

2
Modules/FeatureSummary.cmake
View File

@ -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/>

8
Modules/FindCUDA.cmake
View File

@ -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+.

11
Modules/FindGettext.cmake
View File

@ -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".

2
Modules/FindJava.cmake
View File

@ -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.

8
Modules/FindLibXslt.cmake
View File

@ -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.

7
Modules/FindPkgConfig.cmake
View File

@ -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

12
Modules/FindQt4.cmake
View File

@ -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)

3
Modules/FindSDL_image.cmake
View File

@ -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
#
#
#

3
Modules/FindSDL_mixer.cmake
View File

@ -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
#
#
#

3
Modules/FindSquish.cmake
View File

@ -41,7 +41,8 @@
#
# ::
#
# squish_v4_add_test(cmakeTestName AUT targetName SUITE suiteName TEST squishTestName
# squish_v4_add_test(cmakeTestName
# AUT targetName SUITE suiteName TEST squishTestName
# [SETTINGSGROUP group] [PRE_COMMAND command] [POST_COMMAND command] )
#
#