Browse Source

FindCURL: Revise documentation markup

Brad King 7 years ago
parent
commit
ee06f3c339
1 changed files with 15 additions and 7 deletions
  1. 15 7
      Modules/FindCURL.cmake

+ 15 - 7
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)