diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2022-06-12 16:00:55 +0200 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2022-06-12 16:00:55 +0200 |
| commit | 8307b90e8136e7c3adc6d0419f6eda0d58b27614 (patch) | |
| tree | be9db0c4e70741754cbb0b0c3e72ef3ad60fb768 /modules | |
| parent | 1ea9e4249f332e481a4940c63b3868504e8b6a3e (diff) | |
| download | extra-cmake-modules-8307b90e8136e7c3adc6d0419f6eda0d58b27614.tar.gz extra-cmake-modules-8307b90e8136e7c3adc6d0419f6eda0d58b27614.tar.bz2 | |
API dox: improve linking to other modules referenced in text
NO_CHANGELOG
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/ECMCreateQmFromPoFiles.cmake | 2 | ||||
| -rw-r--r-- | modules/ECMDeprecationSettings.cmake | 2 | ||||
| -rw-r--r-- | modules/ECMEnableSanitizers.cmake | 2 | ||||
| -rw-r--r-- | modules/ECMGenerateDBusServiceFile.cmake | 2 |
4 files changed, 4 insertions, 4 deletions
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. |