diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2022-06-12 18:11:16 +0200 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2022-06-12 18:27:40 +0200 |
| commit | 97de5ca22bc2e9270809a24d00fe6b748ddbb9e7 (patch) | |
| tree | 0a79fed871a41afe701c6556bc10c72f93ea786d /kde-modules | |
| parent | 08b0e02f8ecd3cec4840f5025729e5b40d890645 (diff) | |
| download | extra-cmake-modules-97de5ca22bc2e9270809a24d00fe6b748ddbb9e7.tar.gz extra-cmake-modules-97de5ca22bc2e9270809a24d00fe6b748ddbb9e7.tar.bz2 | |
API dox: turn some more verbal "Note" into full note sections
Should help readers being aware of pitfalls
NO_CHANGELOG
Diffstat (limited to 'kde-modules')
| -rw-r--r-- | kde-modules/KDECMakeSettings.cmake | 7 | ||||
| -rw-r--r-- | kde-modules/KDECompilerSettings.cmake | 5 | ||||
| -rw-r--r-- | kde-modules/KDEFrameworkCompilerSettings.cmake | 5 |
3 files changed, 10 insertions, 7 deletions
diff --git a/kde-modules/KDECMakeSettings.cmake b/kde-modules/KDECMakeSettings.cmake index 8950cfb1..d2d06b18 100644 --- a/kde-modules/KDECMakeSettings.cmake +++ b/kde-modules/KDECMakeSettings.cmake @@ -27,9 +27,10 @@ dynamically-linked libraries) is set to include the location that libraries will be installed to (as set in ``LIB_INSTALL_DIR`` or, if the former is not set, ``KDE_INSTALL_LIBDIR``), and also the linker search path. -Note that ``LIB_INSTALL_DIR`` or alternatively ``KDE_INSTALL_LIBDIR`` needs -to be set before including this module. -Typically, this is done by including the :kde-module:`KDEInstallDirs` module. +.. note:: + ``LIB_INSTALL_DIR`` or alternatively ``KDE_INSTALL_LIBDIR`` needs + to be set before including this module. + Typically, this is done by including the :kde-module:`KDEInstallDirs` module. This section can be disabled by setting ``KDE_SKIP_RPATH_SETTINGS`` to ``TRUE`` before including this module. diff --git a/kde-modules/KDECompilerSettings.cmake b/kde-modules/KDECompilerSettings.cmake index ceb313ac..08881507 100644 --- a/kde-modules/KDECompilerSettings.cmake +++ b/kde-modules/KDECompilerSettings.cmake @@ -19,8 +19,9 @@ for some compiler features. By default, exceptions are disabled; ``kde_target_enable_exceptions()`` can be used to re-enable them for a specific target. -NB: it is recommended to include this module with the ``NO_POLICY_SCOPE`` -flag, otherwise you may get spurious warnings with some versions of CMake. +.. note:: + It is recommended to include this module with the ``NO_POLICY_SCOPE`` + flag, otherwise you may get spurious warnings with some versions of CMake. Since 5.85 newer settings are controlled by a variable ``KDE_COMPILERSETTINGS_LEVEL``, taking an ECM version as value. That diff --git a/kde-modules/KDEFrameworkCompilerSettings.cmake b/kde-modules/KDEFrameworkCompilerSettings.cmake index 73b0cff5..bbe38026 100644 --- a/kde-modules/KDEFrameworkCompilerSettings.cmake +++ b/kde-modules/KDEFrameworkCompilerSettings.cmake @@ -23,8 +23,9 @@ For example, constructions like ``QString("foo")`` are prohibited, instead forcing the use of QLatin1String or QStringLiteral, and some Qt-defined keywords like signals and slots will not be defined. -NB: it is recommended to include this module with the NO_POLICY_SCOPE -flag, otherwise you may get spurious warnings with some versions of CMake. +.. note:: + It is recommended to include this module with the NO_POLICY_SCOPE + flag, otherwise you may get spurious warnings with some versions of CMake. Since pre-1.0.0. #]=======================================================================] |