diff options
author | Brad King <brad.king@kitware.com> | 2014-10-22 19:52:31 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2014-10-22 19:52:31 (GMT) |
commit | 58b2d760ee094e6f1a4a8701f86efcb81977b047 (patch) | |
tree | 2cf1d02b16f8519155779e052dd21639894fb226 /Modules/CMakeFindPackageMode.cmake | |
parent | 54ff77dc621a91302abad0ab38d9bd26de8914b9 (diff) | |
download | CMake-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/CMakeFindPackageMode.cmake')
-rw-r--r-- | Modules/CMakeFindPackageMode.cmake | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/Modules/CMakeFindPackageMode.cmake b/Modules/CMakeFindPackageMode.cmake index 9f97ee5..fc3058d 100644 --- a/Modules/CMakeFindPackageMode.cmake +++ b/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 -# COMPILER_ID = the CMake compiler ID for which the result is, i.e. GNU/Intel/Clang/MSVC, etc. -# LANGUAGE = language for which the result will be used, i.e. C/CXX/Fortan/ASM -# 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 +# ``NAME`` +# name of the package +# ``COMPILER_ID`` +# the CMake compiler ID for which the result is, +# i.e. GNU/Intel/Clang/MSVC, etc. +# ``LANGUAGE`` +# language for which the result will be used, +# i.e. C/CXX/Fortan/ASM +# ``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> |