FindHSPELL: Update documentation

- Synced module description with other similar find modules.
- Added examples section
- HSPELL_DEFINITIONS variable removed from the documentation as it was
  never defined by this module.
This commit is contained in:
Peter Kokot
2025-04-02 01:54:31 +02:00
parent b6c88c0c5d
commit c27d2bee7f

View File

@@ -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)