diff options
| author | Brad King <brad.king@kitware.com> | 2014-10-22 15:52:31 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-10-22 15:52:31 -0400 |
| commit | 58b2d760ee094e6f1a4a8701f86efcb81977b047 (patch) | |
| tree | 2cf1d02b16f8519155779e052dd21639894fb226 /Modules/CMakePrintHelpers.cmake | |
| parent | 54ff77dc621a91302abad0ab38d9bd26de8914b9 (diff) | |
| download | cmake-58b2d760ee094e6f1a4a8701f86efcb81977b047.tar.gz | |
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/CMakePrintHelpers.cmake')
| -rw-r--r-- | Modules/CMakePrintHelpers.cmake | 19 |
1 files changed, 7 insertions, 12 deletions
diff --git a/Modules/CMakePrintHelpers.cmake b/Modules/CMakePrintHelpers.cmake index ad3b0d585b..474fa41b96 100644 --- a/Modules/CMakePrintHelpers.cmake +++ b/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: -# -# :: -# -# cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION THIS_ONE_DOES_NOT_EXIST) +# Example:: # -# Gives: +# cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION DOES_NOT_EXIST) # -# :: +# Gives:: # -# -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; THIS_ONE_DOES_NOT_EXIST="" +# -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; DOES_NOT_EXIST="" #============================================================================= # Copyright 2013 Alexander Neundorf, <neundorf@kde.org> |