From d920b323bd66bc5bde3c4b9e6dca8b289bb35058 Mon Sep 17 00:00:00 2001 From: Volker Krause Date: Tue, 12 Feb 2019 10:25:01 +0100 Subject: [PATCH] Follow ECM documentation style Summary: In preparation for upstreaming to ECM, as qtbase needs this as well. Reviewers: apol Reviewed By: apol Subscribers: kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D18944 --- cmake/modules/FindXKB.cmake | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/cmake/modules/FindXKB.cmake b/cmake/modules/FindXKB.cmake index 0d599df0fd..ffaa9022d7 100644 --- a/cmake/modules/FindXKB.cmake +++ b/cmake/modules/FindXKB.cmake @@ -1,16 +1,25 @@ -# Try to find xkbcommon on a Unix system +#.rst: +# FindXKB +# ------- # -# This will define: +# Try to find xkbcommon on a Unix system +# If found, this will define the following variables: # -# XKB_FOUND - True if XKB is available -# XKB_LIBRARIES - Link these to use XKB -# XKB_INCLUDE_DIRS - Include directory for XKB -# XKB_DEFINITIONS - Compiler flags for using XKB +# ``XKB_FOUND`` +# True if XKB is available +# ``XKB_LIBRARIES`` +# Link these to use XKB +# ``XKB_INCLUDE_DIRS`` +# Include directory for XKB +# ``XKB_DEFINITIONS`` +# Compiler flags for using XKB # # Additionally, the following imported targets will be defined: # -# XKB::XKB -# +# ``XKB::XKB`` +# The XKB library + +#============================================================================= # Copyright (c) 2014 Martin Gräßlin # # Redistribution and use in source and binary forms, with or without @@ -36,6 +45,7 @@ # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF # SUCH DAMAGE. +#============================================================================= if(CMAKE_VERSION VERSION_LESS 2.8.12) message(FATAL_ERROR "CMake 2.8.12 is required by FindXKB.cmake")