aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFriedrich W. H. Kossebau <kossebau@kde.org>2022-06-12 16:00:55 +0200
committerFriedrich W. H. Kossebau <kossebau@kde.org>2022-06-12 16:00:55 +0200
commit8307b90e8136e7c3adc6d0419f6eda0d58b27614 (patch)
treebe9db0c4e70741754cbb0b0c3e72ef3ad60fb768
parent1ea9e4249f332e481a4940c63b3868504e8b6a3e (diff)
downloadextra-cmake-modules-8307b90e8136e7c3adc6d0419f6eda0d58b27614.tar.gz
extra-cmake-modules-8307b90e8136e7c3adc6d0419f6eda0d58b27614.tar.bz2
API dox: improve linking to other modules referenced in text
NO_CHANGELOG
-rw-r--r--kde-modules/KDEClangFormat.cmake2
-rw-r--r--kde-modules/KDECompilerSettings.cmake2
-rw-r--r--kde-modules/KDEFrameworkCompilerSettings.cmake2
-rw-r--r--kde-modules/KDEInstallDirs.cmake4
-rw-r--r--kde-modules/KDEInstallDirs5.cmake2
-rw-r--r--modules/ECMCreateQmFromPoFiles.cmake2
-rw-r--r--modules/ECMDeprecationSettings.cmake2
-rw-r--r--modules/ECMEnableSanitizers.cmake2
-rw-r--r--modules/ECMGenerateDBusServiceFile.cmake2
9 files changed, 10 insertions, 10 deletions
diff --git a/kde-modules/KDEClangFormat.cmake b/kde-modules/KDEClangFormat.cmake
index 46be8ad6..50dfc850 100644
--- a/kde-modules/KDEClangFormat.cmake
+++ b/kde-modules/KDEClangFormat.cmake
@@ -27,7 +27,7 @@ The ``.clang-format`` file from ECM will be copied to the source directory. This
added to version control. It is recommended to add it to the ``.gitignore`` file: ``/.clang-format``.
Since 5.79: If the source folder already contains a .clang-format file it is not overwritten.
-Since version 5.80 this function is called by default in KDEFrameworkCompilerSettings. If directories should be excluded from
+Since version 5.80 this function is called by default in :kde-module:`KDEFrameworkCompilerSettings`. If directories should be excluded from
the formatting a .clang-format file with "DisableFormat: true" and "SortIncludes: false" should be created.
Example usage:
diff --git a/kde-modules/KDECompilerSettings.cmake b/kde-modules/KDECompilerSettings.cmake
index 55b94c38..e5acd59b 100644
--- a/kde-modules/KDECompilerSettings.cmake
+++ b/kde-modules/KDECompilerSettings.cmake
@@ -147,7 +147,7 @@ Inclusion of this module defines the following variables:
This option only has an effect on ELF-based systems.
The option is disabled by default except when using
- KDEFrameworkCompilerSettings.cmake where it's enabled. Projects can enable
+ :kde-module:`KDEFrameworkCompilerSettings` where it's enabled. Projects can enable
it by calling set(ENABLE_BSYMBOLICFUNCTIONS ON) or passing -DENABLE
BSYMBOLICFUNCTIONS=ON when configuring the build directory.
diff --git a/kde-modules/KDEFrameworkCompilerSettings.cmake b/kde-modules/KDEFrameworkCompilerSettings.cmake
index fa31a93b..bebc33cd 100644
--- a/kde-modules/KDEFrameworkCompilerSettings.cmake
+++ b/kde-modules/KDEFrameworkCompilerSettings.cmake
@@ -15,7 +15,7 @@ Set stricter compile and link flags for KDE Frameworks modules.
Do not use this module for software which is not part of KDE-Frameworks.
There is no guarantee for backward-compatibility in newer versions.
-The KDECompilerSettings module is included and, in addition, various
+The :kde-module:`KDECompilerSettings` module is included and, in addition, various
defines that affect the Qt libraries are set to enforce certain
conventions.
diff --git a/kde-modules/KDEInstallDirs.cmake b/kde-modules/KDEInstallDirs.cmake
index 5dbf97d9..86c39368 100644
--- a/kde-modules/KDEInstallDirs.cmake
+++ b/kde-modules/KDEInstallDirs.cmake
@@ -6,9 +6,9 @@
KDEInstallDirs
--------------
-Compatibility wrapper around KDEInstallDirs5.
+Compatibility wrapper around :kde-module:`KDEInstallDirs5`.
-Since 5.82.0, prior to that equivalent to KDEInstallDirs5.
+Since 5.82.0, prior to that equivalent to :kde-module:`KDEInstallDirs5`.
#]=======================================================================]
include(${CMAKE_CURRENT_LIST_DIR}/../modules/QtVersionOption.cmake)
diff --git a/kde-modules/KDEInstallDirs5.cmake b/kde-modules/KDEInstallDirs5.cmake
index 03411965..20a034f3 100644
--- a/kde-modules/KDEInstallDirs5.cmake
+++ b/kde-modules/KDEInstallDirs5.cmake
@@ -209,7 +209,7 @@ be used on the command line when possible (eg: use
``-DKDE_INSTALL_LIBDIR=lib64`` instead of
``-DKDE_INSTALL_LIBDIR=/usr/lib/lib64`` to override the library directory).
-Since 5.82.0, prior to that available as KDEInstallDirs.
+Since 5.82.0, prior to that available as :kde-module:`KDEInstallDirs`.
NB: The variables starting ``KDE_INSTALL_`` are available since 1.6.0,
unless otherwise noted with the variable.
diff --git a/modules/ECMCreateQmFromPoFiles.cmake b/modules/ECMCreateQmFromPoFiles.cmake
index c02ba2c7..98e656d3 100644
--- a/modules/ECMCreateQmFromPoFiles.cmake
+++ b/modules/ECMCreateQmFromPoFiles.cmake
@@ -7,7 +7,7 @@ ECMCreateQmFromPoFiles
----------------------
.. warning:: This module is deprecated and will be removed by ECM 1.0. Use
- ECMPoQmTools instead.
+ :module:`ECMPoQmTools` instead.
Generate QTranslator (.qm) catalogs from Gettext (.po) catalogs.
diff --git a/modules/ECMDeprecationSettings.cmake b/modules/ECMDeprecationSettings.cmake
index 8288cdf0..8570d9b8 100644
--- a/modules/ECMDeprecationSettings.cmake
+++ b/modules/ECMDeprecationSettings.cmake
@@ -12,7 +12,7 @@ deprecated API for QT and KF projects.
This method expects pairs of the identifier and deprecation version.
For the identifier "QT" this functions adds the definition "QT_DISABLE_DEPRECATED_BEFORE" with the given version in a hexadecimal format.
Otherwise the name for the definition is generated using `${IDENTIFIER}_DISABLE_DEPRECATED_BEFORE_AND_AT`,
-following the naming of the generated code in :kde-module:`ECMGenerateExportHeaders`.
+following the naming of the generated code in :module:`ECMGenerateExportHeader`.
The version for the definition can be overwritten, by passing definition name and the deprecation version
as a CMake definition. This allows one to exclude deprecations without having to edit the CMakeLists.txt file.
diff --git a/modules/ECMEnableSanitizers.cmake b/modules/ECMEnableSanitizers.cmake
index 84f1819c..cc889290 100644
--- a/modules/ECMEnableSanitizers.cmake
+++ b/modules/ECMEnableSanitizers.cmake
@@ -31,7 +31,7 @@ Simply add::
include(ECMEnableSanitizers)
to your ``CMakeLists.txt``. Note that this module is included in
-KDECompilerSettings, so projects using that module do not need to also
+:kde-module:`KDECompilerSettings`, so projects using that module do not need to also
include this one.
The sanitizers are not enabled by default. Instead, you must set
diff --git a/modules/ECMGenerateDBusServiceFile.cmake b/modules/ECMGenerateDBusServiceFile.cmake
index 0b76b5f8..f3c7dd8a 100644
--- a/modules/ECMGenerateDBusServiceFile.cmake
+++ b/modules/ECMGenerateDBusServiceFile.cmake
@@ -24,7 +24,7 @@ A D-Bus service file ``<service name>.service`` will be generated and installed
in the relevant D-Bus config location. This filename can be customized with RENAME.
``<executable>`` must be an absolute path to the installed service executable. When using it with
-``KDEInstallDirs`` it needs to be the ``_FULL_`` variant of the path variable.
+:kde-module:`KDEInstallDirs` it needs to be the ``_FULL_`` variant of the path variable.
Note: On Windows, the macro will only use the file name part of ``<executable>`` since D-Bus
service executables are to be installed in the same directory as the D-Bus daemon.