diff options
author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-17 11:02:00 +0200 |
---|---|---|
committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-23 17:49:14 +0000 |
commit | 5512e03562694ebfe571a3b6068a7d35d9ddfd7a (patch) | |
tree | 3caca041d3526c8427ec3065642b41a52ad8578c /find-modules/FindPhoneNumber.cmake | |
parent | 38b5d046c4d42232d45bf4464167b2e6feea4cf7 (diff) | |
download | extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.gz extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.bz2 |
Modules docs: move rst docs into bracket comments
CMake >= 3.0 supports bracket comments, and the reStructuredText
integration code in sphinx/ext/ecm.py already supports extracting
the docs from a bracket comment instead.
Editing documentation without leading line comment markers is more simple,
e,g. when reflowing text over lines.
With ECM meanwhile requiring CMake 3.5 now it is possible to switch
(and thus follow also the approach used by cmake itself).
NO_CHANGELOG
Diffstat (limited to 'find-modules/FindPhoneNumber.cmake')
-rw-r--r-- | find-modules/FindPhoneNumber.cmake | 59 |
1 files changed, 29 insertions, 30 deletions
diff --git a/find-modules/FindPhoneNumber.cmake b/find-modules/FindPhoneNumber.cmake index 76e1039e..303aaa14 100644 --- a/find-modules/FindPhoneNumber.cmake +++ b/find-modules/FindPhoneNumber.cmake @@ -1,37 +1,36 @@ -#.rst: -# FindPhoneNumber -# --------------- -# -# 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:: -# -# PhoneNumber GeoCoding -# -# If no components are specified, this module will act as though all components -# were passed to OPTIONAL_COMPONENTS. -# -# This module will define the following variables, independently of the -# components searched for or found: -# -# ``PhoneNumber_FOUND`` -# True if (the requestion version of) PhoneNumber is available -# -# For each searched-for components, ``PhoneNumber_<component>_FOUND`` will be set to -# TRUE if the corresponding library was found, and FALSE otherwise. If -# ``PhoneNumber_<component>_FOUND`` is TRUE, the imported target ``PhoneNumber::<component>`` -# will be defined. -# -# Since 5.54.0. - -#============================================================================= # SPDX-FileCopyrightText: 2017 Klaralvdalens Datakonsult AB, a KDAB Group company <info@kdab.com> # SPDX-FileCopyrightText: 2018 Volker Krause <vkrause@kde.org> # # SPDX-License-Identifier: BSD-3-Clause -#============================================================================= + +#[=======================================================================[.rst: +FindPhoneNumber +--------------- + +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:: + + PhoneNumber GeoCoding + +If no components are specified, this module will act as though all components +were passed to OPTIONAL_COMPONENTS. + +This module will define the following variables, independently of the +components searched for or found: + +``PhoneNumber_FOUND`` + True if (the requestion version of) PhoneNumber is available + +For each searched-for components, ``PhoneNumber_<component>_FOUND`` will be set to +TRUE if the corresponding library was found, and FALSE otherwise. If +``PhoneNumber_<component>_FOUND`` is TRUE, the imported target ``PhoneNumber::<component>`` +will be defined. + +Since 5.54.0. +#]=======================================================================] include(ECMFindModuleHelpersStub) |