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/FindGLIB2.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/FindGLIB2.cmake')
-rw-r--r-- | find-modules/FindGLIB2.cmake | 55 |
1 files changed, 27 insertions, 28 deletions
diff --git a/find-modules/FindGLIB2.cmake b/find-modules/FindGLIB2.cmake index 454da9b6..67a018f5 100644 --- a/find-modules/FindGLIB2.cmake +++ b/find-modules/FindGLIB2.cmake @@ -1,34 +1,33 @@ -#.rst: -# FindGLIB2 -# --------- -# -# Try to locate the GLib2 library. -# If found, this will define the following variables: -# -# ``GLIB2_FOUND`` -# True if the GLib2 library is available -# ``GLIB2_INCLUDE_DIRS`` -# The GLib2 include directories -# ``GLIB2_LIBRARIES`` -# The GLib2 libraries for linking -# ``GLIB2_INCLUDE_DIR`` -# Deprecated, use ``GLIB2_INCLUDE_DIRS`` -# ``GLIB2_LIBRARY`` -# Deprecated, use ``GLIB2_LIBRARIES`` -# -# If ``GLIB2_FOUND`` is TRUE, it will also define the following -# imported target: -# -# ``GLIB2::GLIB2`` -# The GLIB2 library -# -# Since 5.41.0. - -#============================================================================= # SPDX-FileCopyrightText: 2008 Laurent Montel <montel@kde.org> # # SPDX-License-Identifier: BSD-3-Clause -#============================================================================= + +#[=======================================================================[.rst: +FindGLIB2 +--------- + +Try to locate the GLib2 library. +If found, this will define the following variables: + +``GLIB2_FOUND`` + True if the GLib2 library is available +``GLIB2_INCLUDE_DIRS`` + The GLib2 include directories +``GLIB2_LIBRARIES`` + The GLib2 libraries for linking +``GLIB2_INCLUDE_DIR`` + Deprecated, use ``GLIB2_INCLUDE_DIRS`` +``GLIB2_LIBRARY`` + Deprecated, use ``GLIB2_LIBRARIES`` + +If ``GLIB2_FOUND`` is TRUE, it will also define the following +imported target: + +``GLIB2::GLIB2`` + The GLIB2 library + +Since 5.41.0. +#]=======================================================================] find_package(PkgConfig) pkg_check_modules(PC_GLIB2 QUIET glib-2.0) |