aboutsummaryrefslogtreecommitdiff
path: root/modules/ECMPackageConfigHelpers.cmake
diff options
context:
space:
mode:
authorFriedrich W. H. Kossebau <kossebau@kde.org>2022-06-12 16:13:22 +0200
committerFriedrich W. H. Kossebau <kossebau@kde.org>2022-06-12 18:27:40 +0200
commit9edb5f57127489dec4b7cbdc1e60920e6002abea (patch)
tree712d3aaeb2d5caa9adc80f2c6e1e4412b54efb97 /modules/ECMPackageConfigHelpers.cmake
parent0ec7ce6f1e2b5b1c914897e7a58f62835cc27ce5 (diff)
downloadextra-cmake-modules-9edb5f57127489dec4b7cbdc1e60920e6002abea.tar.gz
extra-cmake-modules-9edb5f57127489dec4b7cbdc1e60920e6002abea.tar.bz2
API dox: use more markup for code or commandline samples
NO_CHANGELOG
Diffstat (limited to 'modules/ECMPackageConfigHelpers.cmake')
-rw-r--r--modules/ECMPackageConfigHelpers.cmake16
1 files changed, 8 insertions, 8 deletions
diff --git a/modules/ECMPackageConfigHelpers.cmake b/modules/ECMPackageConfigHelpers.cmake
index f320ebc2..c635122e 100644
--- a/modules/ECMPackageConfigHelpers.cmake
+++ b/modules/ECMPackageConfigHelpers.cmake
@@ -24,19 +24,19 @@ more information.
[NO_CHECK_REQUIRED_COMPONENTS_MACRO])
-This behaves in the same way as configure_package_config_file() from CMake
-2.8.12, except that it adds an extra helper macro: find_dependency(). It is
+This behaves in the same way as ``configure_package_config_file()`` from CMake
+2.8.12, except that it adds an extra helper macro: ``find_dependency()``. It is
highly recommended that you read the `documentation for
CMakePackageConfigHelpers
<https://www.cmake.org/cmake/help/v2.8.12/cmake.html#module:CMakePackageConfigHelpers>`_
-for more information, particularly with regard to the PATH_VARS argument.
+for more information, particularly with regard to the ``PATH_VARS`` argument.
-Note that there is no argument that will disable the find_dependency() macro;
+Note that there is no argument that will disable the ``find_dependency()`` macro;
if you do not require this macro, you should use
``configure_package_config_file`` from the CMakePackageConfigHelpers module.
CMake 3.0 includes a CMakeFindDependencyMacro module that provides the
-find_dependency() macro (which you can ``include()`` in your package config
+``find_dependency()`` macro (which you can ``include()`` in your package config
file), so this file is only useful for projects wishing to provide config
files that will work with CMake 2.8.12.
@@ -47,9 +47,9 @@ Additional Config File Macros
find_dependency(<dep> [<version> [EXACT]])
-find_dependency() should be used instead of find_package() to find package
-dependencies. It forwards the correct parameters for EXACT, QUIET and
-REQUIRED which were passed to the original find_package() call. It also sets
+``find_dependency()`` should be used instead of ``find_package()`` to find package
+dependencies. It forwards the correct parameters for ``EXACT``, ``QUIET`` and
+``REQUIRED`` which were passed to the original ``find_package()`` call. It also sets
an informative diagnostic message if the dependency could not be found.
Since pre-1.0.0.