diff options
author | Brad King <brad.king@kitware.com> | 2018-03-07 14:06:01 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2018-03-07 14:06:01 (GMT) |
commit | ee06f3c339e0f90e9a61891d3ad8c71a4286d504 (patch) | |
tree | 1bc41eaf8804653352ad07591e65f10a43d1b1e6 | |
parent | 83c0cb3f0328504baf425704803c2ae83942cb86 (diff) | |
download | CMake-ee06f3c339e0f90e9a61891d3ad8c71a4286d504.zip CMake-ee06f3c339e0f90e9a61891d3ad8c71a4286d504.tar.gz CMake-ee06f3c339e0f90e9a61891d3ad8c71a4286d504.tar.bz2 |
FindCURL: Revise documentation markup
-rw-r--r-- | Modules/FindCURL.cmake | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/Modules/FindCURL.cmake b/Modules/FindCURL.cmake index 1d969a8..e66ae92 100644 --- a/Modules/FindCURL.cmake +++ b/Modules/FindCURL.cmake @@ -5,7 +5,7 @@ # FindCURL # -------- # -# Find curl +# Find the native CURL headers and libraries. # # IMPORTED Targets # ^^^^^^^^^^^^^^^^ @@ -13,14 +13,22 @@ # This module defines :prop_tgt:`IMPORTED` target ``CURL::CURL``, if # curl has been found. # -# Find the native CURL headers and libraries. +# Result Variables +# ^^^^^^^^^^^^^^^^ +# +# This module defines the following variables: +# +# ``CURL_FOUND`` +# True if curl found. +# +# ``CURL_INCLUDE_DIRS`` +# where to find curl/curl.h, etc. # -# :: +# ``CURL_LIBRARIES`` +# List of libraries when using curl. # -# CURL_INCLUDE_DIRS - where to find curl/curl.h, etc. -# CURL_LIBRARIES - List of libraries when using curl. -# CURL_FOUND - True if curl found. -# CURL_VERSION_STRING - the version of curl found (since CMake 2.8.8) +# ``CURL_VERSION_STRING`` +# The version of curl found. # Look for the header file. find_path(CURL_INCLUDE_DIR NAMES curl/curl.h) |