removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -31,32 +31,29 @@ class wxFileConfig : public wxConfigBase
|
||||
public:
|
||||
/**
|
||||
)
|
||||
|
||||
Read the config data from the specified stream instead of the associated file,
|
||||
as usual.
|
||||
|
||||
@sa Save()
|
||||
@see Save()
|
||||
*/
|
||||
wxFileConfig(wxInputStream& is);
|
||||
|
||||
/**
|
||||
Return the full path to the file which would be used by wxFileConfig as global,
|
||||
system-wide, file if it were constructed with @e basename as "global
|
||||
system-wide, file if it were constructed with @a basename as "global
|
||||
filename'' parameter in the constructor. Notice that this function cannot be
|
||||
used if @e basename is already a full path name.
|
||||
used if @a basename is already a full path name.
|
||||
*/
|
||||
static wxFileName GetGlobalFile(const wxString& basename);
|
||||
|
||||
/**
|
||||
Return the full path to the file which would be used by wxFileConfig as local,
|
||||
user-specific, file if it were constructed with @e basename as "local
|
||||
user-specific, file if it were constructed with @a basename as "local
|
||||
filename'' parameter in the constructor.
|
||||
|
||||
@e style has the same meaning as in @ref wxConfigBase::ctor constructor
|
||||
@a style has the same meaning as in @ref wxConfigBase::ctor constructor
|
||||
and can contain any combination of styles but only wxCONFIG_USE_SUBDIR bit is
|
||||
examined by this function.
|
||||
|
||||
Notice that this function cannot be used if @e basename is already a full
|
||||
Notice that this function cannot be used if @a basename is already a full
|
||||
path name.
|
||||
*/
|
||||
static wxFileName GetLocalFile(const wxString& basename,
|
||||
@@ -64,17 +61,15 @@ public:
|
||||
|
||||
/**
|
||||
)
|
||||
|
||||
Saves all config data to the given stream, returns @true if data was saved
|
||||
successfully or @false on error.
|
||||
|
||||
Note the interaction of this function with the internal "dirty flag'': the
|
||||
data is saved unconditionally, i.e. even if the object is not dirty. However
|
||||
after saving it successfully, the dirty flag is reset so no changes will be
|
||||
written back to the file this object is associated with until you change its
|
||||
contents again.
|
||||
|
||||
@sa wxConfigBase::Flush
|
||||
@see wxConfigBase::Flush
|
||||
*/
|
||||
bool Save(wxOutputStream& os);
|
||||
|
||||
@@ -83,10 +78,9 @@ public:
|
||||
create a config file which is not readable by other users (useful if it stores
|
||||
some sensitive information, such as passwords), you could use
|
||||
@c SetUmask(0077).
|
||||
|
||||
This function doesn't do anything on non-Unix platforms.
|
||||
|
||||
@sa wxCHANGE_UMASK
|
||||
@see wxCHANGE_UMASK
|
||||
*/
|
||||
void SetUmask(int mode);
|
||||
};
|
||||
|
Reference in New Issue
Block a user