From b4206d635444580bd00a0e7dabd939d86134ee72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Gr=C3=A4=C3=9Flin?= Date: Sat, 10 Dec 2016 19:20:50 +0100 Subject: [kconfig_compiler] Improve documentation about Inherits Summary: Better specify the requirements the parent class needs to have. KConfigCompiler generates different variants of ctors taking either: * a QStringLiteral argument (name set in * a KSharedConfig::Ptr argument (arg="true" in ) * no argument (Inherits=true in kcfgc and no ) In order to have Inherits generate compiling code in all cases the parent class needs to provide accessible ctors. This change updates the docuementation to reflect this. Reviewers: #frameworks, dfaure Differential Revision: https://phabricator.kde.org/D3636 --- src/kconfig_compiler/README.dox | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/kconfig_compiler/README.dox b/src/kconfig_compiler/README.dox index 968c3778..e11b157b 100644 --- a/src/kconfig_compiler/README.dox +++ b/src/kconfig_compiler/README.dox @@ -108,7 +108,11 @@ The following options are read from the kcfgc file: string KConfigSkeleton Class the generated class inherits from. This class must inherit - KConfigSkeleton. + KConfigSkeleton and must provide a default constructor (kcfgfile not specified), a constructor + taking a QString argument (kcfgfile with "name" attribute) and a constructor taking a + KSharedConfig::Ptr as argument (kcfgfile with "arg" attribute). + Please refer to the documentation of KConfigSkeleton. + Visibility -- cgit v1.2.1