Small API docs fixesv5.60.0-rc1v5.60.0

7 files changed, 28 insertions, 23 deletions

diff --git a/find-modules/FindFontconfig.cmake b/find-modules/FindFontconfig.cmake
index 6ac23a0a..2981a9ac 100644
--- a/find-modules/FindFontconfig.cmake
+++ b/find-modules/FindFontconfig.cmake
@@ -16,7 +16,7 @@
 # ``Fontconfig_VERSION``
 #     The version of Fontconfig that has been found
 #
-# If ``Fontconfig_FOUND`` is True, it will also define the following
+# If ``Fontconfig_FOUND`` is TRUE, it will also define the following
 # imported target:
 #
 # ``Fontconfig::Fontconfig``
diff --git a/find-modules/FindInotify.cmake b/find-modules/FindInotify.cmake
index 15667e02..cc4aa290 100644
--- a/find-modules/FindInotify.cmake
+++ b/find-modules/FindInotify.cmake
@@ -3,7 +3,7 @@
 # --------------
 #
 # Try to find inotify on this system. This finds:
-#  - libinotiy on Unix like systems, or 
+#  - libinotify on Unix like systems, or
 #  - the kernel's inotify on Linux systems.
 #
 # This will define the following variables:
@@ -16,7 +16,7 @@
 #    This has to be passed to target_include_directories()
 #
 # On Linux, the libraries and include directories are empty,
-# even though Inotify_FOUND may be set to TRUE. This is because
+# even though ``Inotify_FOUND`` may be set to TRUE. This is because
 # no special includes or libraries are needed. On other systems
 # these may be needed to use inotify.
 #
diff --git a/find-modules/FindLibExiv2.cmake b/find-modules/FindLibExiv2.cmake
index 935cee2c..d4dfc624 100644
--- a/find-modules/FindLibExiv2.cmake
+++ b/find-modules/FindLibExiv2.cmake
@@ -7,26 +7,29 @@
 # This will define the following variables:
 #
 # ``LibExiv2_FOUND``
-#     System has LibExiv2.
+#     True if (the requested version of) Exiv2 is available
 #
 # ``LibExiv2_VERSION``
-#     The version of LibExiv2.
+#     The version of Exiv2
 #
 # ``LibExiv2_INCLUDE_DIRS``
-#     This should be passed to target_include_directories() if
-#     the target is not used for linking.
+#     The include dirs of Exiv2 for use with target_include_directories()
 #
 # ``LibExiv2_LIBRARIES``
-#     The LibExiv2 library.
+#     The Exiv2 library for use with target_link_libraries().
 #     This can be passed to target_link_libraries() instead of
 #     the ``LibExiv2::LibExiv2`` target
 #
-# If ``LibExiv2_FOUND`` is TRUE, the following imported target
-# will be available:
+# If ``LibExiv2_FOUND`` is TRUE, it will also define the following imported
+# target:
 #
 # ``LibExiv2::LibExiv2``
 #     The Exiv2 library
 #
+# In general we recommend using the imported target, as it is easier to use.
+# Bear in mind, however, that if the target is in the link interface of an
+# exported library, it must be made available by the package config file.
+#
 # Since 5.53.0.
 #
 #=============================================================================
diff --git a/find-modules/FindPhoneNumber.cmake b/find-modules/FindPhoneNumber.cmake
index 4813c1a7..0c628009 100644
--- a/find-modules/FindPhoneNumber.cmake
+++ b/find-modules/FindPhoneNumber.cmake
@@ -2,14 +2,13 @@
 # FindPhoneNumber
 # ---------------
 #
-# This module finds if PhoneNumber is installed.
+# Try to find PhoneNumber.
 #
 # This is a component-based find module, which makes use of the COMPONENTS and
 # OPTIONAL_COMPONENTS arguments to find_module.  The following components are
-# available:
+# available::
 #
-#   PhoneNumber
-#   GeoCoding
+#   PhoneNumber  GeoCoding
 #
 # If no components are specified, this module will act as though all components
 # were passed to OPTIONAL_COMPONENTS.
diff --git a/find-modules/FindPoppler.cmake b/find-modules/FindPoppler.cmake
index 4cbe1d26..db99c697 100644
--- a/find-modules/FindPoppler.cmake
+++ b/find-modules/FindPoppler.cmake
@@ -8,7 +8,7 @@
 # and OPTIONAL_COMPONENTS arguments to find_module.  The following components
 # are available::
 #
-#   Core  Cpp  Qt5  Qt4 Glib
+#   Core  Cpp  Qt5  Qt4  Glib
 #
 # If no components are specified, this module will act as though all components
 # were passed to OPTIONAL_COMPONENTS.
diff --git a/find-modules/FindSeccomp.cmake b/find-modules/FindSeccomp.cmake
index eeb83c45..76c83e8a 100644
--- a/find-modules/FindSeccomp.cmake
+++ b/find-modules/FindSeccomp.cmake
@@ -3,7 +3,8 @@
 # -----------
 #
 # Try to locate the libseccomp library.
-# If found, this will define the following variables:
+#
+# This will define the following variables:
 #
 # ``Seccomp_FOUND``
 #     True if the seccomp library is available
diff --git a/find-modules/FindUDev.cmake b/find-modules/FindUDev.cmake
index b7557415..20d3f112 100644
--- a/find-modules/FindUDev.cmake
+++ b/find-modules/FindUDev.cmake
@@ -2,13 +2,15 @@
 # FindUDev
 # --------
 #
-# Try to find the UDev library, once done this will define:
+# Try to find the UDev library.
 #
-#  ``UDev_FOUND``
-#      System has UDev.
+# This will define the following variables:
 #
-#  ``UDev_INCLUDE_DIRS``
-#      The libudev include directory.
+# ``UDev_FOUND``
+#     System has UDev.
+#
+# ``UDev_INCLUDE_DIRS``
+#     The libudev include directory.
 #
 # ``UDev_LIBRARIES``
 #     The libudev libraries.
@@ -16,8 +18,8 @@
 # ``UDev_VERSION``
 #     The libudev version.
 #
-# If ``UDev_FOUND`` is TRUE, the following imported target
-# will be available:
+# If ``UDev_FOUND`` is TRUE, it will also define the following imported
+# target:
 #
 # ``UDev::UDev``
 #     The UDev library