diff options
| author | Brad King <brad.king@kitware.com> | 2015-08-13 14:53:08 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-08-13 14:53:08 (GMT) |
| commit | 79a364376ca7b4b598b4827031a7515ffd497f24 (patch) | |
| tree | 9f84dd3914585f4a9835bc80869a4664e581d7b1 /Modules/FindOpenSSL.cmake | |
| parent | fb3035a92c9c7038d0c5fdc3fd8268ac371d673b (diff) | |
| download | CMake-79a364376ca7b4b598b4827031a7515ffd497f24.zip CMake-79a364376ca7b4b598b4827031a7515ffd497f24.tar.gz CMake-79a364376ca7b4b598b4827031a7515ffd497f24.tar.bz2 | |
FindOpenSSL: Revise and format module documentation
Improve reStructuredText formatting and add section headers.
Diffstat (limited to 'Modules/FindOpenSSL.cmake')
| -rw-r--r-- | Modules/FindOpenSSL.cmake | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/Modules/FindOpenSSL.cmake b/Modules/FindOpenSSL.cmake index 7545d94..a334354 100644 --- a/Modules/FindOpenSSL.cmake +++ b/Modules/FindOpenSSL.cmake @@ -2,26 +2,30 @@ # FindOpenSSL # ----------- # -# Try to find the OpenSSL encryption library +# Find the OpenSSL encryption library. # -# Once done this will define +# Result Variables +# ^^^^^^^^^^^^^^^^ # -# :: +# This module will set the following variables in your project: # -# OPENSSL_ROOT_DIR - Set this variable to the root installation of OpenSSL +# ``OPENSSL_FOUND`` +# System has the OpenSSL library. +# ``OPENSSL_INCLUDE_DIR`` +# The OpenSSL include directory. +# ``OPENSSL_CRYPTO_LIBRARY`` +# The OpenSSL crypto library. +# ``OPENSSL_SSL_LIBRARY`` +# The OpenSSL SSL library. +# ``OPENSSL_LIBRARIES`` +# All OpenSSL libraries. +# ``OPENSSL_VERSION`` +# This is set to ``$major.$minor.$revision$patch`` (e.g. ``0.9.8s``). # +# Hints +# ^^^^^ # -# -# Read-Only variables: -# -# :: -# -# OPENSSL_FOUND - System has the OpenSSL library -# OPENSSL_INCLUDE_DIR - The OpenSSL include directory -# OPENSSL_CRYPTO_LIBRARY - The OpenSSL crypto library -# OPENSSL_SSL_LIBRARY - The OpenSSL SSL library -# OPENSSL_LIBRARIES - All OpenSSL libraries -# OPENSSL_VERSION - This is set to $major.$minor.$revision$patch (eg. 0.9.8s) +# Set ``OPENSSL_ROOT_DIR`` to the root directory of an OpenSSL installation. #============================================================================= # Copyright 2006-2009 Kitware, Inc. |