From 45d8532f09fbefa14cfaf4d76b7a9672d27e104f Mon Sep 17 00:00:00 2001
From: Cyril Rossi <cyril.rossi@enioka.com>
Date: Thu, 9 Jul 2020 18:30:16 +0200
Subject: Add documentation for ParentInConstructor option

---
 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 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>
 
 
-- 
cgit v1.2.1