Merge topic 'patch-FindHSPELL'

c27d2bee7f FindHSPELL: Update documentation

Acked-by: Kitware Robot <[email protected]>
Merge-request: !10577

Modules/FindHSPELL.cmake

@@ -5,24 +5,40 @@
 FindHSPELL
 ----------
 
-Try to find Hebrew spell-checker (Hspell) and morphology engine.
+Finds Hebrew spell-checker (Hspell) and morphology engine.
 
-Once done this will define
+Result Variables
+^^^^^^^^^^^^^^^^
 
-::
+This module defines the following variables:
 
-  HSPELL_FOUND - system has Hspell
-  HSPELL_INCLUDE_DIR - the Hspell include directory
-  HSPELL_LIBRARIES - The libraries needed to use Hspell
-  HSPELL_DEFINITIONS - Compiler switches required for using Hspell
+``HSPELL_FOUND``
+  Boolean indicating whether the Hspell is found.
+``HSPELL_VERSION_STRING``
+  The version of Hspell found (x.y).
+``HSPELL_MAJOR_VERSION``
+  The major version of Hspell.
+``HSPELL_MINOR_VERSION``
+  The minor version of Hspell.
 
+Cache Variables
+^^^^^^^^^^^^^^^
 
+The following cache variables may also be set:
 
-::
+``HSPELL_INCLUDE_DIR``
+  The Hspell include directory.
+``HSPELL_LIBRARIES``
+  The libraries needed to use Hspell.
 
-  HSPELL_VERSION_STRING - The version of Hspell found (x.y)
-  HSPELL_MAJOR_VERSION  - the major version of Hspell
-  HSPELL_MINOR_VERSION  - The minor version of Hspell
+Examples
+^^^^^^^^
+
+Finding Hspell:
+
+.. code-block:: cmake
+
+  find_package(HSPELL)
 #]=======================================================================]
 
 cmake_policy(PUSH)