From 3a7b8ae9c9b151c20e7b1f9d7f01aa2013a9b25f Mon Sep 17 00:00:00 2001
From: Elvis Angelaccio <elvis.angelaccio@kde.org>
Date: Mon, 24 Oct 2016 11:41:12 +0200
Subject: Add documentation for the GenerateProperties option

REVIEW: 129188
---
 src/kconfig_compiler/README.dox | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src')

diff --git a/src/kconfig_compiler/README.dox b/src/kconfig_compiler/README.dox
index b9606f1d..968c3778 100644
--- a/src/kconfig_compiler/README.dox
+++ b/src/kconfig_compiler/README.dox
@@ -206,6 +206,15 @@ The following options are read from the kcfgc file:
   <td>bool</td>
   <td>false</td>
   <td>If set to true, forces the first parameter of the generated class to be a QString when using an argument for the filename. This is useful to specify at runtime the filename of the configuration class.</td>
+</tr>
+<tr>
+  <td><b>GenerateProperties</b></td>
+  <td>bool</td>
+  <td>false</td>
+  <td>If set to true, a Q_PROPERTY will be generated for each member variable holding a configuration value
+  and the Q_OBJECT macro will be added to the generated class.
+  Note that you will also need to pass the GENERATE_MOC option to the kconfig_add_kcfg_files macro.</td>
+</tr>
 </table>
 
 
-- 
cgit v1.2.1