aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCyril Rossi <cyril.rossi@enioka.com>2020-07-09 18:30:16 +0200
committerCyril Rossi <cyril.rossi@enioka.com>2020-08-10 13:54:21 +0000
commit45d8532f09fbefa14cfaf4d76b7a9672d27e104f (patch)
tree4bd6a04af7049a01b0bb863371ae4d190dcab98b
parentbc25027aeb0fad8de48d47a87cf3101e8e4304f6 (diff)
downloadkconfig-45d8532f09fbefa14cfaf4d76b7a9672d27e104f.tar.gz
kconfig-45d8532f09fbefa14cfaf4d76b7a9672d27e104f.tar.bz2
Add documentation for ParentInConstructor option
-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 55e59736..bf72f3eb 100644
--- a/src/kconfig_compiler/README.dox
+++ b/src/kconfig_compiler/README.dox
@@ -245,6 +245,15 @@ The following options are read from the kcfgc file:
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>
+<tr>
+ <td><b>ParentInConstructor</b></td>
+ <td>bool</td>
+ <td>false</td>
+ <td>If set to true, the generated constructor will take an additional QObject* parameter that will be used as the object's parent.
+ This is useful when working with KQuickAddons::ManagedConfigModule to set it as the parent of the generated class to allow automatic settings discovery and handle the deallocation.
+ Note this parameter is incompatible with <b>Singleton</b> set to true.
+ </td>
+</tr>
</table>