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/FindTaglib.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/FindTaglib.cmake')
| -rw-r--r-- | find-modules/FindTaglib.cmake | 54 |
1 files changed, 28 insertions, 26 deletions
diff --git a/find-modules/FindTaglib.cmake b/find-modules/FindTaglib.cmake index ad14c79c..2fd4500e 100644 --- a/find-modules/FindTaglib.cmake +++ b/find-modules/FindTaglib.cmake @@ -1,34 +1,36 @@ -#.rst: -# FindTaglib -# ---------- -# -# Try to find the Taglib library. -# -# This will define the following variables: -# -# ``Taglib_FOUND`` -# True if the system has the taglib library of at least the minimum -# version specified by the version parameter to find_package() -# ``Taglib_INCLUDE_DIRS`` -# The taglib include dirs for use with target_include_directories -# ``Taglib_LIBRARIES`` -# The taglib libraries for use with target_link_libraries() -# ``Taglib_VERSION`` -# The version of taglib that was found -# -# If ``Taglib_FOUND`` is TRUE, it will also define the following imported -# target: -# -# ``Taglib::Taglib`` -# The Taglib library -# -# Since 5.72.0 -# # SPDX-FileCopyrightText: 2006 Laurent Montel <montel@kde.org> # SPDX-FileCopyrightText: 2019 Heiko Becker <heirecka@exherbo.org> # SPDX-FileCopyrightText: 2020 Elvis Angelaccio <elvis.angelaccio@kde.org> +# # SPDX-License-Identifier: BSD-3-Clause +#[=======================================================================[.rst: +FindTaglib +---------- + +Try to find the Taglib library. + +This will define the following variables: + +``Taglib_FOUND`` + True if the system has the taglib library of at least the minimum + version specified by the version parameter to find_package() +``Taglib_INCLUDE_DIRS`` + The taglib include dirs for use with target_include_directories +``Taglib_LIBRARIES`` + The taglib libraries for use with target_link_libraries() +``Taglib_VERSION`` + The version of taglib that was found + +If ``Taglib_FOUND`` is TRUE, it will also define the following imported +target: + +``Taglib::Taglib`` + The Taglib library + +Since 5.72.0 +#]=======================================================================] + find_package(PkgConfig QUIET) pkg_search_module(PC_TAGLIB QUIET taglib) |