Minor wording fixes in wxDataStream classes documentation.

[wxWidgets.git] / interface / wx / stdpaths.h

diff --git a/interface/wx/stdpaths.h b/interface/wx/stdpaths.h
index b4f577662f29568cf4c46f9046a58bbc3bbd6e2d..29d9c849e3928d50c5f02573c141d44e42838a93 100644 (file)
--- a/interface/wx/stdpaths.h
+++ b/interface/wx/stdpaths.h
@@ -115,7 +115,7 @@ public:
     virtual wxString GetConfigDir() const;
 
     /**
     virtual wxString GetConfigDir() const;
 
     /**

-        Return the location of the applications global, i.e. not user-specific,
+        Return the location of the applications global, i.e.\ not user-specific,

         data files.
 
         Example return values:
         data files.
 
         Example return values:


@@ -159,13 +159,16 @@ public:
     virtual wxString GetExecutablePath() const;
 
     /**
     virtual wxString GetExecutablePath() const;
 
     /**

-        Return the program installation prefix, e.g. @c /usr, @c /opt or @c /home/zeitlin.
+        Return the program installation prefix, e.g.\ @c /usr, @c /opt or @c /home/zeitlin.

 
         If the prefix had been previously by SetInstallPrefix(), returns that
         value, otherwise tries to determine it automatically (Linux only right now)
         and finally returns the default @c /usr/local value if it failed.
 
 
         If the prefix had been previously by SetInstallPrefix(), returns that
         value, otherwise tries to determine it automatically (Linux only right now)
         and finally returns the default @c /usr/local value if it failed.
 

-        @note This function is only available under Unix.
+        @note This function is only available under Unix platforms (but not limited
+        to wxGTK mentioned below).
+
+        @onlyfor{wxos2,wxgtk}

     */
     wxString GetInstallPrefix() const;
 
     */
     wxString GetInstallPrefix() const;
 


@@ -237,7 +240,8 @@ public:
         - Mac: @c ~/Library/Preferences
 
         Only use this method if you have a single configuration file to put in this
         - Mac: @c ~/Library/Preferences
 
         Only use this method if you have a single configuration file to put in this

-        directory, otherwise GetUserDataDir() is more appropriate.
+        directory, otherwise GetUserDataDir() is more appropriate as the latter
+        adds @c appinfo to the path, unlike this function.

     */
     virtual wxString GetUserConfigDir() const;
 
     */
     virtual wxString GetUserConfigDir() const;
 


@@ -334,7 +338,10 @@ public:
         is set during program configuration if using GNU autotools and so it is enough
         to pass its value defined in @c config.h to this function.
 
         is set during program configuration if using GNU autotools and so it is enough
         to pass its value defined in @c config.h to this function.
 

-        @note This function is only available under Unix.
+        @note This function is only available under Unix platforms (but not limited
+        to wxGTK mentioned below).
+
+        @onlyfor{wxos2,wxgtk}

     */
     void SetInstallPrefix(const wxString& prefix);
 
     */
     void SetInstallPrefix(const wxString& prefix);