summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMike Krus <mike.krus@kdab.com>2017-06-13 18:07:42 +0100
committerMike Krus <mike.krus@kdab.com>2017-06-14 09:08:00 +0000
commit52f9e19ab0dd917f56cffc2a1ed646c1415dd517 (patch)
tree80596224a041cc58f459ad64bffc8215f4a18cfd /src
parent3c613812a4fb007d7c0b63cadcaaaa3c53e26cf3 (diff)
downloadqtivi-52f9e19ab0dd917f56cffc2a1ed646c1415dd517.tar.gz
Add documentation for generator qface integration
Task-number: QTAUTO-447 Change-Id: I8bad10cf72c66af738f0b7aec81c7fdc1b7d51f5 Reviewed-by: Dominik Holland <dominik.holland@pelagicore.com>
Diffstat (limited to 'src')
-rw-r--r--src/doc/qtivi/src/qface-main.qdoc2
-rw-r--r--src/doc/qtivi/src/qmake-integration.qdoc36
2 files changed, 37 insertions, 1 deletions
diff --git a/src/doc/qtivi/src/qface-main.qdoc b/src/doc/qtivi/src/qface-main.qdoc
index 45b7a0d..0641096 100644
--- a/src/doc/qtivi/src/qface-main.qdoc
+++ b/src/doc/qtivi/src/qface-main.qdoc
@@ -37,6 +37,6 @@ library, which provides a generic autogeneration framework.
\li \l {QFace IDL syntax}
\li \l {Jinja template syntax}
\li \l {AutoGenerator Usage}
- \li \l {qmake integration}
+ \li \l {Qmake integration}
\endlist
*/
diff --git a/src/doc/qtivi/src/qmake-integration.qdoc b/src/doc/qtivi/src/qmake-integration.qdoc
index 7931fc3..a4f22f0 100644
--- a/src/doc/qtivi/src/qmake-integration.qdoc
+++ b/src/doc/qtivi/src/qmake-integration.qdoc
@@ -29,6 +29,42 @@
\title Qmake integration
\previouspage AutoGenerator usage
+Qt IVI Generator has been integrated with QMake to generate all or part of projects.
+In it's simplest form, QMake can generate all the source code and the project only
+need to configure what type of project is built.
+
+For complex setups, generated code can be combined with application specific code
+which can extend and use it.
+
+Example:
+\code
+CONFIG += ivigenerator
+
+QFACE_FORMAT = frontend
+QFACE_SOURCES = example.qface
+QFACE_MODULE_NAME = myModule
+QFACE_OUTPUT_DIR = myOutputDir
+\endcode
+
+Available QMake Variables:
+\table
+ \row
+ \li QFACE_FORMAT
+ \li frontend (default), simulator_backend
+ \row
+ \li QFACE_SOURCES
+ \li list of .qface input files
+ \row
+ \li QFACE_MODULE_NAME
+ \li The (optional) name of the module that is using the generated code
+ \row
+ \li QFACE_OUTPUT_DIR
+ \li Output folder where the generated code will be created. The default
+ is to use the current build folder
+\endtable
+
+
+See \l {AutoGenerator usage} for more details on the generator command line arguments.
*/