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

List:       kde-commits
Subject:    KDE/kdelibs/kdecore/config
From:       Aaron J. Seigo <aseigo () kde ! org>
Date:       2010-06-04 17:30:37
Message-ID: 20100604173037.47FFFAC8C9 () svn ! kde ! org
[Download RAW message or body]

SVN commit 1134606 by aseigo:

document the in-memory-only mode


 M  +8 -2      kconfig.h  


--- trunk/KDE/kdelibs/kdecore/config/kconfig.h #1134605:1134606
@@ -115,7 +115,10 @@
      *
      * @note You probably want to use KSharedConfig::openConfig instead.
      *
-     * @param file         the name of the file
+     * @param file         the name of the file. If an empty string is passed in 
+     *                     and SimpleConfig is passed in for the OpenFlags, then an in-memory
+     *                     KConfig object is created which will not write out to file nor which
+     *                     requires any file in the filesystem at all.
      * @param mode         how global settings should affect the configuration
      *                     options exposed by this KConfig object
      * @param resourceType The standard directory to look for the configuration
@@ -144,7 +147,10 @@
      *
      * @param componentData the component that you wish to load a configuration
      *                      file for
-     * @param file          overrides the configuration file name if not empty
+     * @param file          overrides the configuration file name if not empty; if it is empty
+     *                      and SimpleConfig is passed in for the OpenFlags, then an in-memory
+     *                      KConfig object is created which will not write out to file nor which
+     *                      requires any file in the filesystem at all.
      * @param mode          how global settings should affect the configuration
      *                      options exposed by this KConfig object.
      *                      See OpenFlags
[prev in list] [next in list] [prev in thread] [next in thread]