doc: Add documentation for the control_panel template

Change-Id: Ib54ee5185b30d31b9f459f7033ffca6adee25428
Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>

1 files changed, 48 insertions, 1 deletions

diff --git a/src/doc/qtivi/src/generator-usage.qdoc b/src/doc/qtivi/src/generator-usage.qdoc
index 2159919..918ccfc 100644
--- a/src/doc/qtivi/src/generator-usage.qdoc
+++ b/src/doc/qtivi/src/generator-usage.qdoc
@@ -52,7 +52,7 @@ The options and parameters are:
         \li specifies whether the generator should keep track of the changes in the IDL file
         and update output on the fly (--no-reload by default)
     \row
-        \li  -f, --format [frontend|backend_simulator|<folder>]
+        \li  -f, --format [frontend|backend_simulator|control_panel|<folder>]
         \li see below
     \row
         \li --help
@@ -80,6 +80,10 @@ These are:
     \li Generates a simulation backend for the API generated by the "frontend" option. This
     backend serves as a mock implementation.
   \row
+    \li control_panel
+    \li Generates a controller application, consisting of an UI and a C++ plugin, which communicates
+        to the simulation backend generated from the same qface file using QtSimulator.
+  \row
     \li folder path
     \li Uses templates inside the folder. A YAML file with the same name as the folder (and .yaml
     extension) should provide a list of template files in the folder (see YAML format specification below).
@@ -307,5 +311,48 @@ created. All the generated files will be put in this folder. The following files
         \li Files containing the implementation of the simulation backend.
 \endtable
 
+\section2 Control Panel
+
+The control_panel template is only available if the QtSimulator module was found. Please see the \l{feature-qtsimulator}{Configuration Page}
+for more information.
+
+\table
+    \header
+        \li File name
+        \li Purpose
+    \row
+        \li "main.cpp"
+        \li Launcher code loading the QML code and exporting the C++ interface.
+    \row
+        \li "main.qml"
+        \li Main QML file containing the code to load the Control UIs for every interface.
+    \row
+        \li "qml.qrc"
+        \li QRC file for all QML code.
+    \row
+        \li "FlagControl.qml"
+        \li UI Element to control a flag inside a interface.
+    \row
+        \li "EnumControl.qml"
+        \li UI Element to control a enum inside a interface.
+    \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.
+    \row
+        \li "{{module.module_name|lower}}global.h"
+        \li Standard file with global EXPORT defines
+    \row
+        \li "{{module.module_name|lower}}module.h/cpp"
+        \li Files defining a module class used for module global variables and types.
+    \row
+        \li "{{interface|lower}}.h/cpp"
+        \li C++ code retrieving and forwarding the state using QtSimulator.
+    \row
+        \li "{{module.module_name|lower}}ControlUi.qml"
+        \li Control UI for this interface. Contains a interface to control every
+        property and method and log calls to signals.
+\endtable
+
 
 */