Finished review/fixes of GDI category of functions and macros.

[wxWidgets.git] / interface / fileconf.h

diff --git a/interface/fileconf.h b/interface/fileconf.h
index f8810f2046a300d107099dc24168e1f4c6947812..abcddfd9ad6d3e19ee080f5b740e7f49d6df1a27 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
@@ -23,40 +23,36 @@
     @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,17 +60,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 +77,10 @@ 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);
 };
+