From fe300454292c519ae5aa4edfcb1b94f3636e59bb Mon Sep 17 00:00:00 2001 From: Matthew Dawson Date: Thu, 11 Sep 2014 22:31:46 -0400 Subject: 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. --- src/core/kconfigbase.h | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'src') 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 + * \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 { -- cgit v1.2.1