diff options
author | Alex Merry <alex.merry@kde.org> | 2014-04-10 21:38:09 +0100 |
---|---|---|
committer | Alex Merry <alex.merry@kde.org> | 2014-04-11 21:12:58 +0100 |
commit | c20d22c951e61a06701f6c2201add7c11915e7c5 (patch) | |
tree | a8f375967eaeeceffac6da5098700b4563bf2306 /find-modules/FindWayland.cmake | |
parent | ddd33b850bb519174511a34eeda40af69a1f7144 (diff) | |
download | extra-cmake-modules-c20d22c951e61a06701f6c2201add7c11915e7c5.tar.gz extra-cmake-modules-c20d22c951e61a06701f6c2201add7c11915e7c5.tar.bz2 |
Add documentation generation using Sphinx
This is deliberately modelled very closely on CMake's documentation
system. It's a hefty patch, because it involved changing all the
documentation to be in reStructuredText format. I also cleaned up the
copyright/license statements at the same time.
Note that the find modules contain the full license, due to the fact
that ecm_use_find_module() copies them out of the ECM distribution.
Diffstat (limited to 'find-modules/FindWayland.cmake')
-rw-r--r-- | find-modules/FindWayland.cmake | 58 |
1 files changed, 40 insertions, 18 deletions
diff --git a/find-modules/FindWayland.cmake b/find-modules/FindWayland.cmake index c7c599c2..b7790e75 100644 --- a/find-modules/FindWayland.cmake +++ b/find-modules/FindWayland.cmake @@ -1,8 +1,12 @@ -# Try to find Wayland on a Unix system +#.rst: +# FindWayland +# ----------- +# +# Try to find Wayland on a Unix system. # # 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: +# are available:: # # Client Server Cursor Egl # @@ -12,33 +16,51 @@ # This module will define the following variables, independently of the # components searched for or found: # -# Wayland_FOUND - True if (the requestion version of) Wayland is available -# Wayland_VERSION - Found Wayland version +# ``Wayland_FOUND`` +# True if (the requestion version of) Wayland is available +# ``Wayland_VERSION`` +# Found Wayland version # -# For each searched-for components, Wayland_<component>_FOUND will be set to true -# if the corresponding Wayland library was found, and false otherwise. If -# Wayland_<component>_FOUND is true, the imported target Wayland::<component> will be -# defined. This module will also attempt to determine Wayland_*_VERSION variables -# for each imported target, although Wayland_VERSION should normally be sufficient. +# For each searched-for components, ``Wayland_<component>_FOUND`` will be set to +# true if the corresponding Wayland library was found, and false otherwise. If +# ``Wayland_<component>_FOUND`` is true, the imported target +# ``Wayland::<component>`` will be defined. This module will also attempt to +# determine ``Wayland_*_VERSION`` variables for each imported target, although +# ``Wayland_VERSION`` should normally be sufficient. # # The following variable will also be defined for convenience, and for # compatibility with old-style find module conventions: # -# Wayland_LIBRARIES - A list of all Wayland imported targets +# ``Wayland_LIBRARIES`` +# A list of all Wayland imported targets #============================================================================= -# Copyright 2014 Martin Gräßlin <mgraesslin@kde.org> # Copyright 2014 Alex Merry <alex.merry@kde.org> +# Copyright 2014 Martin Gräßlin <mgraesslin@kde.org> +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: # -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file COPYING-CMAKE-SCRIPTS for details. +# 1. Redistributions of source code must retain the copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. # -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 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. #============================================================================= -# (To distribute this file outside of extra-cmake-modules, substitute the full -# License text for the above reference.) include(${CMAKE_CURRENT_LIST_DIR}/../modules/ECMFindModuleHelpers.cmake) |