[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdelibs/kdecore/config
From:       Sebastian Trueg <sebastian () trueg ! de>
Date:       2009-02-18 19:00:35
Message-ID: 1234983635.052440.25146.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 927995 by trueg:

Updated documentation: calling KConfigGroup::Sync is mandatory if one wants the changes to stick

 M  +10 -1     kconfiggroup.h  


--- trunk/KDE/kdelibs/kdecore/config/kconfiggroup.h #927994:927995
@@ -49,6 +49,9 @@
  *
  * A KConfigGroup will be read-only if it is constructed from a
  * const config object or from another read-only group.
+ *
+ * Changes to a KConfigGroup need to be synced back to the 
+ * parent config via sync().
  */
 class KDECORE_EXPORT KConfigGroup : public KConfigBase
 {
@@ -121,7 +124,13 @@
      */
     bool exists() const;
 
-    /// @reimp
+    /**
+     * @reimp
+     *
+     * Syncs the group back to the parent config. Without calling this
+     * method changes to the group will not appear in the parent config
+     * and thus, will never be written back to disk.
+     */
     void sync();
 
     /// @reimp
[prev in list] [next in list] [prev in thread] [next in thread]