From c20d22c951e61a06701f6c2201add7c11915e7c5 Mon Sep 17 00:00:00 2001 From: Alex Merry Date: Thu, 10 Apr 2014 21:38:09 +0100 Subject: 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. --- find-modules/FindSharedMimeInfo.cmake | 59 +++++++++++++++++++++++++---------- 1 file changed, 43 insertions(+), 16 deletions(-) (limited to 'find-modules/FindSharedMimeInfo.cmake') diff --git a/find-modules/FindSharedMimeInfo.cmake b/find-modules/FindSharedMimeInfo.cmake index 8dc6f1c4..263a5028 100644 --- a/find-modules/FindSharedMimeInfo.cmake +++ b/find-modules/FindSharedMimeInfo.cmake @@ -1,29 +1,56 @@ -# Try to find the shared-mime-info package +#.rst: +# FindSharedMimeInfo +# ------------------ # -# This will define +# Try to find the shared-mime-info package. # -# SharedMimeInfo_FOUND - True if system has the shared-mime-info package -# UPDATE_MIME_DATABASE_EXECUTABLE - The update-mime-database executable +# This will define the following variables: # -# In addition, the following targets are defined: +# ``SharedMimeInfo_FOUND`` +# True if system has the shared-mime-info package +# ``UPDATE_MIME_DATABASE_EXECUTABLE`` +# The update-mime-database executable # -# SharedMimeInfo::UpdateMimeDatabase +# and the following imported targets: # -# The follow macro is available: +# ``SharedMimeInfo::UpdateMimeDatabase`` +# The update-mime-database executable # -# update_xdg_mimetypes(path) +# The follow macro is available:: # -# Updates the XDG mime database at install time (unless the DESTDIR environment -# variable is set, in which case it is up to package managers to perform this -# task). +# update_xdg_mimetypes() # +# Updates the XDG mime database at install time (unless the ``$DESTDIR`` +# environment variable is set, in which case it is up to package managers to +# perform this task). - -# Copyright (c) 2007, Pino Toscano, -# Copyright (c) 2013-2014, Alex Merry, +#============================================================================= +# Copyright 2013-2014 Alex Merry +# Copyright 2007 Pino Toscano +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# 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. # -# Redistribution and use is allowed according to the terms of the BSD license. -# For details see the accompanying COPYING-CMAKE-SCRIPTS file. +# 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. +#============================================================================= if(CMAKE_VERSION VERSION_LESS 2.8.12) message(FATAL_ERROR "CMake 2.8.12 is required by FindSharedMimeInfo.cmake") -- cgit v1.2.1