diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-17 11:02:00 +0200 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-23 17:49:14 +0000 |
| commit | 5512e03562694ebfe571a3b6068a7d35d9ddfd7a (patch) | |
| tree | 3caca041d3526c8427ec3065642b41a52ad8578c /modules/ECMGenerateQmlTypes.cmake | |
| parent | 38b5d046c4d42232d45bf4464167b2e6feea4cf7 (diff) | |
| download | extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.gz extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.bz2 | |
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
Diffstat (limited to 'modules/ECMGenerateQmlTypes.cmake')
| -rw-r--r-- | modules/ECMGenerateQmlTypes.cmake | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/modules/ECMGenerateQmlTypes.cmake b/modules/ECMGenerateQmlTypes.cmake index 7e4899de..d6e12426 100644 --- a/modules/ECMGenerateQmlTypes.cmake +++ b/modules/ECMGenerateQmlTypes.cmake @@ -1,32 +1,32 @@ -#.rst: -# ECMGenerateQmlTypes -# ------------------- -# -# Generates plugins.qmltypes files for QML plugins. -# -# :: -# -# ecm_generate_qmltypes(<org.kde.pluginname> 1.3 -# DESTINATION <${KDE_INSTALL_QMLDIR}/org/kde/pluginname>) -# -# Makes it possible to generate plugins.qmltypes files for the QML plugins that -# our project offers. These files offer introspection upon our plugin and are -# useful for integrating with IDE language support of our plugin. It offers -# information about the objects its methods and their argument types. -# -# The developer will be in charge of making sure that these files are up to date. -# The plugin.qmltypes file will sit in the source directory. This function will -# include the code that installs the file in the right place and a small unit -# test named qmltypes-pluginname-version that makes sure that it doesn't need updating. -# -# -# Since 5.33.0 - -#============================================================================= # SPDX-FileCopyrightText: 2017 Aleix Pol Gonzalez <aleixpol@kde.org> # # SPDX-License-Identifier: BSD-3-Clause +#[=======================================================================[.rst: +ECMGenerateQmlTypes +------------------- + +Generates plugins.qmltypes files for QML plugins. + +:: + + ecm_generate_qmltypes(<org.kde.pluginname> 1.3 + DESTINATION <${KDE_INSTALL_QMLDIR}/org/kde/pluginname>) + +Makes it possible to generate plugins.qmltypes files for the QML plugins that +our project offers. These files offer introspection upon our plugin and are +useful for integrating with IDE language support of our plugin. It offers +information about the objects its methods and their argument types. + +The developer will be in charge of making sure that these files are up to date. +The plugin.qmltypes file will sit in the source directory. This function will +include the code that installs the file in the right place and a small unit +test named qmltypes-pluginname-version that makes sure that it doesn't need updating. + + +Since 5.33.0 +#]=======================================================================] + include(CMakeParseArguments) function(ecm_generate_qmltypes) if (NOT TARGET qmltypes) |