summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorMike Krus <mike.krus@kdab.com>2017-04-19 08:33:21 +0100
committerMike Krus <mike.krus@kdab.com>2017-05-02 09:28:28 +0000
commitf693ca7cc7fb876d15fb8322ef9815e9dd54eb67 (patch)
treeddec247f91a809bf0373891962596a9a0e045b93 /examples
parent6f49233ea4438aa51275e62aea7ace3bc89e8d51 (diff)
downloadqtivi-f693ca7cc7fb876d15fb8322ef9815e9dd54eb67.tar.gz
Add documentation to generated front end code
Also using formating macro to produce the output. Unfortunately doesn't appear to be a way to share template files between folders. Task-number: QTAUTO-339 Change-Id: I3d150475a4c4ba20afe2d0e18fd1af05820a1281 Reviewed-by: Vadim Popov <vadim.popov@pelagicore.com>
Diffstat (limited to 'examples')
-rw-r--r--examples/qface-ivi-climate/qface-ivi-climate.qface13
1 files changed, 8 insertions, 5 deletions
diff --git a/examples/qface-ivi-climate/qface-ivi-climate.qface b/examples/qface-ivi-climate/qface-ivi-climate.qface
index 9e38460..b552fb5 100644
--- a/examples/qface-ivi-climate/qface-ivi-climate.qface
+++ b/examples/qface-ivi-climate/qface-ivi-climate.qface
@@ -1,3 +1,6 @@
+/**
+ * Test module
+ */
module example.ivi.climate 1.0;
/**
@@ -20,7 +23,7 @@ interface ClimateControl {
*/
int fanSpeedLevel;
/**
- * @brief value holds the steering wheel heater level, where the level can
+ * @brief value holds the steering wheel heater level, where the level can
* be between minimumValue(off) to maximumValue (warmest).
*/
int steeringWheelHeater;
@@ -91,19 +94,19 @@ interface ClimateControl {
}
/**
- * Control where the airflow goes
+ * @brief Control where the airflow goes
*/
flag AirflowDirection {
/**
- * Airflow to the windshield
+ * @brief Airflow to the windshield
*/
Windshield = 1,
/**
- * Airflow to the dashboard
+ * @brief Airflow to the dashboard
*/
Dashboard = 2,
/**
- * Airflow to the floor
+ * @brief Airflow to the floor
*/
Floor = 4
}