diff --git a/kde-modules/KDEClangFormat.cmake b/kde-modules/KDEClangFormat.cmake index d00f2c9..472727a 100644 --- a/kde-modules/KDEClangFormat.cmake +++ b/kde-modules/KDEClangFormat.cmake @@ -1,82 +1,84 @@ #.rst: # KDEClangFormat # -------------------- # # This module provides a functionality to format the source # code of your repository according to a predefined KDE # clang-format file. # # This module provides the following function: # # :: # # kde_clang_format() # -# Using this function will create a clang-format target that will format all -# passed to the function with the predefined KDE clang-format style. +# Using this function will create a clang-format target that will format all +# ```` passed to the function with the predefined KDE clang-format style. # -# Example usage: +# Example usage: +# +# .. code-block:: cmake # # include(KDEClangFormat) # file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES src/*.cpp src/*.h) # kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES}) # # Since 5.64 #============================================================================= # Copyright 2019 Christoph Cullmann # # 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. # # 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. # try to find clang-format in path find_program(KDE_CLANG_FORMAT_EXECUTABLE clang-format) # instantiate our clang-format file, must be in source directory for tooling if we have the tool if(KDE_CLANG_FORMAT_EXECUTABLE) configure_file(${CMAKE_CURRENT_LIST_DIR}/clang-format.cmake ${CMAKE_CURRENT_SOURCE_DIR}/.clang-format @ONLY) endif() # formatting target function(KDE_CLANG_FORMAT) # add target only if clang-format available if(KDE_CLANG_FORMAT_EXECUTABLE) add_custom_target(clang-format COMMAND ${KDE_CLANG_FORMAT_EXECUTABLE} -style=file -i ${ARGV} WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} COMMENT "Formatting sources in ${CMAKE_CURRENT_SOURCE_DIR} with ${KDE_CLANG_FORMAT_EXECUTABLE}..." ) else() add_custom_target(clang-format COMMAND ${CMAKE_COMMAND} -E echo "Could not set up the clang-format target as the clang-format executable is missing." ) endif() endfunction()