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/FindRuby.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/FindRuby.cmake')
| -rw-r--r-- | Modules/FindRuby.cmake | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/Modules/FindRuby.cmake b/Modules/FindRuby.cmake index aafdc09..b5ac703 100644 --- a/Modules/FindRuby.cmake +++ b/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 -# 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 +# Also: # -# -# -# :: -# -# 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. |