From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 22 Dec 2010 13:56:56 +0000 (+0000)
Subject: Correct and extend wxConfig::Create() documentation.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/ba67d647e86150b88d5a6781460251920fb92c83

Correct and extend wxConfig::Create() documentation.

Replace mentions of the non-existent wxCONFIG_WIN32_NATIVE with
wxUSE_CONFIG_NATIVE. Also explain what does the "best implementation" really
mean and link to wxAppTraitsBase::CreateConfig().

Closes #12787.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66426 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/config.h b/interface/wx/config.h
index 1aa8db02a3..ba8bfff7ac 100644
--- a/interface/wx/config.h
+++ b/interface/wx/config.h
@@ -845,10 +845,26 @@ public:
 
 
     /**
-        Create a new config object: this function will create the "best"
-        implementation of wxConfig available for the current platform, see
-        comments near the definition of wxCONFIG_WIN32_NATIVE for details. It
-        returns the created object and also sets it as the current one.
+        Create a new config object and sets it as the current one.
+
+        This function will create the most appropriate implementation of
+        wxConfig available for the current platform. By default this means that
+        the system registry will be used for storing the configuration
+        information under MSW and a file under the user home directory (see
+        wxStandardPaths::GetUserConfigDir()) elsewhere.
+
+        If you prefer to use the configuration files everywhere, you can define
+        @c wxUSE_CONFIG_NATIVE to 0 when compiling wxWidgets. Or you can simply
+        always create wxFileConfig explicitly.
+
+        Finally, if you want to create a custom wxConfig subclass you may
+        change this function behaviour by overriding wxAppTraits::CreateConfig()
+        to create it. An example when this could be useful could be an
+        application which could be installed either normally (in which case the
+        default behaviour of using wxRegConfig is appropriate) or in a
+        "portable" way in which case a wxFileConfig with a file in the program
+        directory would be used and the choice would be done in CreateConfig()
+        at run-time.
     */
     static wxConfigBase* Create();