aboutsummaryrefslogtreecommitdiff
path: root/src/kconfig_compiler
diff options
context:
space:
mode:
authorElvis Angelaccio <elvis.angelaccio@kde.org>2016-10-24 11:41:12 +0200
committerElvis Angelaccio <elvis.angelaccio@kde.org>2016-10-24 11:41:12 +0200
commit3a7b8ae9c9b151c20e7b1f9d7f01aa2013a9b25f (patch)
tree8a49fd7138767b03cf86b5ef17d863e2d6b36273 /src/kconfig_compiler
parentc51d77ff9d80f83de9b41c0e22a136588d85aa02 (diff)
downloadkconfig-3a7b8ae9c9b151c20e7b1f9d7f01aa2013a9b25f.tar.gz
kconfig-3a7b8ae9c9b151c20e7b1f9d7f01aa2013a9b25f.tar.bz2
Add documentation for the GenerateProperties option
REVIEW: 129188
Diffstat (limited to 'src/kconfig_compiler')
-rw-r--r--src/kconfig_compiler/README.dox9
1 files changed, 9 insertions, 0 deletions
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>