diff options
| author | Matthew Dawson <matthew@mjdsystems.ca> | 2014-09-11 22:31:46 -0400 |
|---|---|---|
| committer | Matthew Dawson <matthew@mjdsystems.ca> | 2014-09-11 22:31:46 -0400 |
| commit | fe300454292c519ae5aa4edfcb1b94f3636e59bb (patch) | |
| tree | e5e2840f753d616dae35b557cfd65c6cedff905a | |
| parent | 26e7a3f4278667e451e837882de256c2d0206281 (diff) | |
| download | kconfig-fe300454292c519ae5aa4edfcb1b94f3636e59bb.tar.gz kconfig-fe300454292c519ae5aa4edfcb1b94f3636e59bb.tar.bz2 | |
Add class description to KConfigBase.
Add a class description to KConfigBase so that KConfig::sync can link to
KConfigBase::sync. Also makes KConfigBase easier to find and understand.
| -rw-r--r-- | src/core/kconfigbase.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/core/kconfigbase.h b/src/core/kconfigbase.h index 3d00d98a..998c3570 100644 --- a/src/core/kconfigbase.h +++ b/src/core/kconfigbase.h @@ -34,6 +34,11 @@ class KConfigBasePrivate; /** * \class KConfigBase kconfigbase.h <KConfigBase> + * \brief Interface to interact with configuration. + * + * KConfigBase allows a component of an application to persists its configuration + * without the component knowing if it is storing the configuration into a top + * level KConfig or a KConfigGroup inside a KConfig instance. */ class KCONFIGCORE_EXPORT KConfigBase { |