diff options
| author | Martin Gräßlin <mgraesslin@kde.org> | 2016-12-10 19:20:50 +0100 |
|---|---|---|
| committer | Martin Gräßlin <mgraesslin@kde.org> | 2016-12-17 09:49:46 +0100 |
| commit | b4206d635444580bd00a0e7dabd939d86134ee72 (patch) | |
| tree | 4001eb39e3cca737bfb7db6e2ca25a4a7e9a47f8 /src | |
| parent | e6c88f67e2cb660e049a478a8d55220c235aa9c5 (diff) | |
| download | kconfig-b4206d635444580bd00a0e7dabd939d86134ee72.tar.gz kconfig-b4206d635444580bd00a0e7dabd939d86134ee72.tar.bz2 | |
[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 <kcfgfile>
* a KSharedConfig::Ptr argument (arg="true" in <kcfgfile>)
* no argument (Inherits=true in kcfgc and no <kcfgfile>)
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
Diffstat (limited to 'src')
| -rw-r--r-- | src/kconfig_compiler/README.dox | 6 |
1 files changed, 5 insertions, 1 deletions
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: <td>string</td> <td>KConfigSkeleton</td> <td>Class the generated class inherits from. This class must inherit - KConfigSkeleton.</td> + 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. + </td> </tr> <tr> <td><b>Visibility</b></td> |