From 5512e03562694ebfe571a3b6068a7d35d9ddfd7a Mon Sep 17 00:00:00 2001 From: "Friedrich W. H. Kossebau" Date: Sat, 17 Apr 2021 11:02:00 +0200 Subject: Modules docs: move rst docs into bracket comments CMake >= 3.0 supports bracket comments, and the reStructuredText integration code in sphinx/ext/ecm.py already supports extracting the docs from a bracket comment instead. Editing documentation without leading line comment markers is more simple, e,g. when reflowing text over lines. With ECM meanwhile requiring CMake 3.5 now it is possible to switch (and thus follow also the approach used by cmake itself). NO_CHANGELOG --- find-modules/FindIcoTool.cmake | 55 +++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 28 deletions(-) (limited to 'find-modules/FindIcoTool.cmake') diff --git a/find-modules/FindIcoTool.cmake b/find-modules/FindIcoTool.cmake index 40a45913..11243cd4 100644 --- a/find-modules/FindIcoTool.cmake +++ b/find-modules/FindIcoTool.cmake @@ -1,35 +1,34 @@ -#.rst: -# FindIcoTool -# ----------- -# -# Try to find icotool. -# -# If the icotool executable is not in your PATH, you can provide -# an alternative name or full path location with the ``IcoTool_EXECUTABLE`` -# variable. -# -# This will define the following variables: -# -# ``IcoTool_FOUND`` -# True if icotool is available. -# -# ``IcoTool_EXECUTABLE`` -# The icotool executable. -# -# If ``IcoTool_FOUND`` is TRUE, it will also define the following imported -# target: -# -# ``IcoTool::IcoTool`` -# The icotool executable. -# -# Since 5.49. - -#============================================================================= # SPDX-FileCopyrightText: 2017 Vincent Pinon # SPDX-FileCopyrightText: 2014 Alex Merry # # SPDX-License-Identifier: BSD-3-Clause -#============================================================================= + +#[=======================================================================[.rst: +FindIcoTool +----------- + +Try to find icotool. + +If the icotool executable is not in your PATH, you can provide +an alternative name or full path location with the ``IcoTool_EXECUTABLE`` +variable. + +This will define the following variables: + +``IcoTool_FOUND`` + True if icotool is available. + +``IcoTool_EXECUTABLE`` + The icotool executable. + +If ``IcoTool_FOUND`` is TRUE, it will also define the following imported +target: + +``IcoTool::IcoTool`` + The icotool executable. + +Since 5.49. +#]=======================================================================] include(${CMAKE_CURRENT_LIST_DIR}/ECMFindModuleHelpersStub.cmake) ecm_find_package_version_check(IcoTool) -- cgit v1.2.1