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. --- kde-modules/KDECompilerSettings.cmake | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) (limited to 'kde-modules/KDECompilerSettings.cmake') diff --git a/kde-modules/KDECompilerSettings.cmake b/kde-modules/KDECompilerSettings.cmake index d1f9d298..229e4f59 100644 --- a/kde-modules/KDECompilerSettings.cmake +++ b/kde-modules/KDECompilerSettings.cmake @@ -1,3 +1,7 @@ +#.rst: +# KDECompilerSettings +# ------------------- +# # Set useful compile and link flags for C++ (and C) code. # # Enables many more warnings than the default, and sets stricter modes @@ -5,25 +9,44 @@ # kde_target_enable_exceptions() can be used to re-enable them for a # specific target. # -# -# This module provides the following functions: +# This module provides the following functions:: # # kde_source_files_enable_exceptions([file1 [file2 [...]]]) # # Enables exceptions for specific source files. This should not be # used on source files in a language other than C++. # +# :: +# # kde_target_enable_exceptions(target ) # # Enables exceptions for a specific target. This should not be used # on a target that has source files in a language other than C++. # +# :: +# # kde_enable_exceptions() # # Enables exceptions for C++ source files compiled for the # CMakeLists.txt file in the current directory and all subdirectories. -# +#============================================================================= +# Copyright 2014 Alex Merry +# Copyright 2013 Stephen Kelly +# Copyright 2012-2013 Raphael Kubo da Costa +# Copyright 2007 Matthias Kretz +# Copyright 2006-2007 Laurent Montel +# Copyright 2006-2013 Alex Neundorf +# +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file COPYING-CMAKE-SCRIPTS for details. +# +# 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. +#============================================================================= +# (To distribute this file outside of extra-cmake-modules, substitute the full +# License text for the above reference.) ############################################################ # Toolchain minimal requirements -- cgit v1.2.1