use wx-style header and commets; fix indentation to be 4 spaces; move Doxygen comment...

[wxWidgets.git] / interface / fileconf.h

diff --git a/interface/fileconf.h b/interface/fileconf.h
index 84434c631702887ed3dd334407820c3b881b1131..cd51b2437635ab5bbc085927104f9abcdfb38f1b 100644 (file)
--- a/interface/fileconf.h
+++ b/interface/fileconf.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        fileconf.h
-// Purpose:     documentation for wxFileConfig class
+// Purpose:     interface of wxFileConfig
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,54 +9,50 @@
 /**
     @class wxFileConfig
     @wxheader{fileconf.h}
-    
+
     wxFileConfig implements wxConfigBase interface for
     storing and retrieving configuration information using plain text files. The
     files have a simple format reminiscent of Windows INI files with lines of the
     form @c key = value defining the keys and lines of special form
     @c [group] indicating the start of each group.
-    
+
     This class is used by default for wxConfig on Unix platforms but may also be
     used explicitly if you want to use files and not the registry even under
     Windows.
-    
+
     @library{wxbase}
     @category{FIXME}
-    
-    @seealso
-    wxFileConfig::Save
+
+    @see wxFileConfig::Save
 */
 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,29 +60,27 @@ 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);
 
     /**
         Allows to set the mode to be used for the config file creation. For example, to
         create a config file which is not readable by other users (useful if it stores
-        some sensitive information, such as passwords), you could use 
+        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);
 };
+