diff options
author | Dominik Holland <dominik.holland@pelagicore.com> | 2019-01-22 16:01:19 +0100 |
---|---|---|
committer | Dominik Holland <dominik.holland@pelagicore.com> | 2019-02-11 13:42:26 +0000 |
commit | 958e60a4d4b76abd8bf05db0d573daadce0da5e0 (patch) | |
tree | 587b149b306e9c11a575e61fa726a5bde6aaa9f4 /src/ivicore/doc | |
parent | a9f486c8836f545f04db8d2bbf83b1b2ee484678 (diff) | |
download | qtivi-958e60a4d4b76abd8bf05db0d573daadce0da5e0.tar.gz |
ivigenerator: Generate documentation for the QML module singleton
This includes the generation of a module_qml_enum.qdocinc file which
contains the QML documentation of the enum. The qdoc include
command is used in all functions and properties where the enum is
used.
Fixes: AUTOSUITE-741
Change-Id: I095147acd20910c8d7d5b85d95bee6c6e4bd3dd3
Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>
Diffstat (limited to 'src/ivicore/doc')
-rw-r--r-- | src/ivicore/doc/src/ivigenerator/generator-usage.qdoc | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc b/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc index 3ddefd5..33090d8 100644 --- a/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc +++ b/src/ivicore/doc/src/ivigenerator/generator-usage.qdoc @@ -317,6 +317,9 @@ created. All the generated files will be put in this folder. The following files \li "{{module.module_name|lower}}module.h/cpp" \li Files defining a module class used for module global variables and types. \row + \li "{{module.module_name|lower}}module_enum.qdocinc" + \li Documentation for all values of all enums which can be included by qdoc. + \row \li "{{module|lower|replace('.', '-')}}.pri" \li Standard Qt .pri file, containing all the generated files that can be used for including the autogenerated files into a qmake project. |