diff options
author | Dominik Holland <dominik.holland@pelagicore.com> | 2017-09-26 15:09:30 +0200 |
---|---|---|
committer | Robert Griebl <robert.griebl@pelagicore.com> | 2017-10-18 12:04:03 +0000 |
commit | ca2c188d1b7b179938b5d12895caeda7df04c1fe (patch) | |
tree | 3b460abdb77e4a42826ecc4a1162f659226f7864 | |
parent | 65854012dc821a3475d8a6ee854625e1894dffd1 (diff) |
Minor doc fixes
Change-Id: I15ab1a6e6c10275f523d9b28ec3a5668f0e10901
Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>
-rw-r--r-- | src/doc/qtivi/src/generator-usage.qdoc | 14 | ||||
-rw-r--r-- | src/doc/qtivi/src/ivigenerator.qdoc (renamed from src/doc/qtivi/src/qface-main.qdoc) | 6 | ||||
-rw-r--r-- | src/doc/qtivi/src/qmake-integration.qdoc | 6 | ||||
-rw-r--r-- | src/doc/qtivi/src/template-syntax.qdoc | 2 | ||||
-rw-r--r-- | src/ivicore/doc/qtivicore.qdocconf | 2 | ||||
-rw-r--r-- | src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl | 1 |
6 files changed, 17 insertions, 14 deletions
diff --git a/src/doc/qtivi/src/generator-usage.qdoc b/src/doc/qtivi/src/generator-usage.qdoc index 0feea0c..2159919 100644 --- a/src/doc/qtivi/src/generator-usage.qdoc +++ b/src/doc/qtivi/src/generator-usage.qdoc @@ -26,23 +26,23 @@ ****************************************************************************/ /*! \page generator-usage.html -\title AutoGenerator usage +\title Autogenerator usage \previouspage Jinja template syntax -\nextpage Qmake integration +\nextpage Qmake Integration This page is about the usage of the QtIVI auto-generator. \section1 Introduction -The Generator is a Python script that can be run manually or using the qmake integration (see \l -{Qmakeintegration}). This script uses QFace as the autogenerator framework which parses the IDL +The Generator is a Python script that can be run manually or using the \l {QMake Integration}. +This script uses QFace as the autogenerator framework which parses the IDL file, generates the domain-model (similar to AST) and then feeds it to the actual generator. Depending on the type of the generated project, different \e{formats} are specified. \section1 Command line parameters The generation is run using the following command: \code -$$[QT_HOST_BINS]/ivigenerator/generate.py interface.qface out_dir --format=backend_simulator +$$[QT_HOST_BINS]/ivigenerator/generate.py --format=backend_simulator interface.qface out_dir \endcode The options and parameters are: @@ -152,8 +152,8 @@ For QtIvi there are following annotations used for the IDL definition: \li Main IDL file \li Module \li Declares a function which will be called in the plugin to generate the instances for every interface. - The function takes a pointer to the plugin instance and returns a \code {QVector<QIviFeatureInterface *>}. - Interfaces should be generated in the same order as defined by \code {Plugin::interfaces()}. + The function takes a pointer to the plugin instance and returns a \c {QVector<QIviFeatureInterface *>}. + Interfaces should be generated in the same order as defined by \c {Plugin::interfaces()}. This can be used to instanciate classes derived from the generated plugin interfaces classes. \row diff --git a/src/doc/qtivi/src/qface-main.qdoc b/src/doc/qtivi/src/ivigenerator.qdoc index 71fba56..a024555 100644 --- a/src/doc/qtivi/src/qface-main.qdoc +++ b/src/doc/qtivi/src/ivigenerator.qdoc @@ -25,7 +25,7 @@ ** ****************************************************************************/ /*! -\page qface-main.html +\page ivigenerator.html \title The Qt IVI Autogenerator \keyword QFace @@ -36,8 +36,8 @@ library, which provides a generic autogeneration framework. \list \li \l {QFace IDL syntax} \li \l {Jinja template syntax} - \li \l {AutoGenerator Usage} - \li \l {Qmake integration} + \li \l {Autogenerator Usage} + \li \l {QMake Integration} \li \l {qface-ivi-climate}{Generator Example} \endlist */ diff --git a/src/doc/qtivi/src/qmake-integration.qdoc b/src/doc/qtivi/src/qmake-integration.qdoc index a4f22f0..37a4a30 100644 --- a/src/doc/qtivi/src/qmake-integration.qdoc +++ b/src/doc/qtivi/src/qmake-integration.qdoc @@ -26,8 +26,8 @@ ****************************************************************************/ /*! \page qmake-integration.html -\title Qmake integration -\previouspage AutoGenerator usage +\title QMake Integration +\previouspage Autogenerator usage Qt IVI Generator has been integrated with QMake to generate all or part of projects. @@ -65,6 +65,6 @@ Available QMake Variables: \endtable -See \l {AutoGenerator usage} for more details on the generator command line arguments. +See \l {Autogenerator usage} for more details on the generator command line arguments. */ diff --git a/src/doc/qtivi/src/template-syntax.qdoc b/src/doc/qtivi/src/template-syntax.qdoc index e404305..2550189 100644 --- a/src/doc/qtivi/src/template-syntax.qdoc +++ b/src/doc/qtivi/src/template-syntax.qdoc @@ -32,7 +32,7 @@ \page template-syntax.html \title Jinja template syntax \previouspage QFace IDL syntax -\nextpage AutoGenerator usage +\nextpage Autogenerator usage This page is about the Jinja template engine. While the most detailed description of the template language can be found at \l {http://jinja.pocoo.org/docs/dev/templates/}{Jinja documentation}, diff --git a/src/ivicore/doc/qtivicore.qdocconf b/src/ivicore/doc/qtivicore.qdocconf index 844f89a..3aa0eea 100644 --- a/src/ivicore/doc/qtivicore.qdocconf +++ b/src/ivicore/doc/qtivicore.qdocconf @@ -4,6 +4,8 @@ headerdirs += .. \ sourcedirs += .. \ ../../imports/core +exampledirs += ../../../examples/core \ + macro.qmlqtiviproperty = "\\qmlpropertygroup \2 \n\\qmlproperty bool \2.available\n \\qmlproperty \1 \2.maximumValue\n \\qmlproperty \1 \2.minimumValue\n \\qmlproperty list<\1> \2.availableValues\n \\qmlproperty \1 \2.value\n \\include src/qmlqtiviproperty.qdocinc" macro.qmlqtivipropertyBool = "\\qmlpropertygroup \1 \n\\qmlproperty bool \1.available\n \\qmlproperty bool \1.value\n \\include src/qmlqtiviproperty.qdocinc" macro.qmlqtivipropertyEnum = "\\qmlpropertygroup \1 \n\\qmlproperty bool \1.available\n \\qmlproperty list<enumeration> \1.availableValues\n \\qmlproperty enumeration \1.value\n \\include src/qmlqtiviproperty.qdocinc" diff --git a/src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl b/src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl index 0c0ce82..c4e453e 100644 --- a/src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl +++ b/src/tools/ivigenerator/templates_frontend/backendinterface.cpp.tpl @@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE {% else %} \inherits QIviFeatureInterface {% endif %} + \keyword {{interface.tags.config.id}} \brief Backend interface for {{interface}}. The {{class}} is the interface used by \l {{interface}} |