From a4a06df3b4061e4ab4d273ceb19e1430f08bee66 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sat, 10 Dec 2011 11:42:49 +0000 Subject: [PATCH] Document wxFileConfig ctor. This ctor was not documented at all because the comment preceding it was a plain C++ comment and not a Doxygen one. Do it now, especially as the logic of this ctor is not quite obvious. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69976 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/fileconf.h | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/interface/wx/fileconf.h b/interface/wx/fileconf.h index 5f22d8a79d..14ea2df11f 100644 --- a/interface/wx/fileconf.h +++ b/interface/wx/fileconf.h @@ -27,9 +27,21 @@ class wxFileConfig : public wxConfigBase { public: - - // New constructor: one size fits all. Specify wxCONFIG_USE_LOCAL_FILE or - // wxCONFIG_USE_GLOBAL_FILE to say which files should be used. + /** + Constructor allowing to choose the file names to use. + + If @a localFilename and/or @a globalFilename are explicitly specified, + they are used as the names of the user and system-wide configuration + files (the latter is only read by the program while the former is read + from and written to). Otherwise the behaviour depends on @a style + parameter. If it includes ::wxCONFIG_USE_LOCAL_FILE, then the local + file name is constructed from the information in @a appName and @a + vendorName arguments in a system-dependent way. If + ::wxCONFIG_USE_GLOBAL_FILE is not specified at all (and @a + globalFilename is empty) then the system-wide file is not used at all. + Otherwise its name and path are also constructed in the way appropriate + for the current platform from the application and vendor names. + */ wxFileConfig(const wxString& appName = wxEmptyString, const wxString& vendorName = wxEmptyString, const wxString& localFilename = wxEmptyString, -- 2.45.2