]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/stdpaths.h
Try out - instead of @li, more backslash escaping
[wxWidgets.git] / interface / stdpaths.h
index 9b3520581807b99a6313a9f69445ceeef1160018..62b0bc3003375fb63ac907f7fab8f5e4bdb9bf95 100644 (file)
@@ -54,9 +54,9 @@ public:
     /**
         Return the directory containing the system config files.
         Example return values:
-             @li Unix: @c /etc
-             @li Windows: @c C:\\Documents and Settings\\All Users\\Application Data
-             @li Mac: @c /Library/Preferences
+             - Unix: @c /etc
+             - Windows: @c C:\\Documents @c and @c Settings\\All Users\\Application Data
+             - Mac: @c /Library/Preferences
 
         @see wxFileConfig
     */
@@ -66,9 +66,9 @@ public:
         Return the location of the applications global, i.e. not user-specific,
         data files.
         Example return values:
-             @li Unix: @c prefix/share/appname
-             @li Windows: the directory where the executable file is located
-             @li Mac: @c appname.app/Contents/SharedSupport bundle subdirectory
+             - Unix: @c prefix/share/@e appname
+             - Windows: the directory where the executable file is located
+             - Mac: @c @e appname.app/Contents/SharedSupport bundle subdirectory
 
         @see GetLocalDataDir()
     */
@@ -77,9 +77,9 @@ public:
     /**
         Return the directory containing the current user's documents.
         Example return values:
-             @li Unix: @c ~ (the home directory)
-             @li Windows: @c C:\\Documents and Settings\\username\\Documents
-             @li Mac: @c ~/Documents
+             - Unix: @c ~ (the home directory)
+             - Windows: @c C:\\Documents @c and @c Settings\\@e username\\Documents
+             - Mac: @c ~/Documents
 
         @wxsince{2.7.0}
     */
@@ -88,9 +88,9 @@ public:
     /**
         Return the directory and the filename for the current executable.
         Example return values:
-             @li Unix: @c /usr/local/bin/exename
-             @li Windows: @c C:\\Programs\\AppFolder\\exename.exe
-             @li Mac: @c /Programs/exename
+             - Unix: @c /usr/local/bin/@e exename
+             - Windows: @c C:\\Programs\\AppFolder\\@e exename.exe
+             - Mac: @c /Programs/@e exename
     */
     wxString GetExecutablePath() const;
 
@@ -128,9 +128,9 @@ public:
     /**
         Return the directory where the loadable modules (plugins) live.
         Example return values:
-             @li Unix: @c @e prefix/lib/@e appname
-             @li Windows: the directory of the executable file
-             @li Mac: @c @e appname.app/Contents/PlugIns bundle subdirectory
+             - Unix: @c @e prefix/lib/@e appname
+             - Windows: the directory of the executable file
+             - Mac: @c @e appname.app/Contents/PlugIns bundle subdirectory
 
         @see wxDynamicLibrary
     */
@@ -143,9 +143,9 @@ public:
         This function is the same as GetDataDir() for
         all platforms except Mac OS X.
         Example return values:
-             @li Unix: @c @e prefix/share/@e appname
-             @li Windows: the directory where the executable file is located
-             @li Mac: @c @e appname.app/Contents/Resources bundle subdirectory
+             - Unix: @c @e prefix/share/@e appname
+             - Windows: the directory where the executable file is located
+             - Mac: @c @e appname.app/Contents/Resources bundle subdirectory
 
         @wxsince{2.7.0}
 
@@ -165,9 +165,9 @@ public:
 
     /**
         Return the directory for the user config files:
-             @li Unix: @c ~ (the home directory)
-             @li Windows: @c C:\Documents and Settings\@e username\Application Data
-             @li Mac: @c ~/Library/Preferences
+             - Unix: @c ~ (the home directory)
+             - Windows: @c C:\\Documents @c and @c Settings\\@e username\\Application Data
+             - 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.
@@ -176,20 +176,17 @@ public:
 
     /**
         Return the directory for the user-dependent application data files:
-             @li Unix: @c ~/.@e appname
-             @li Windows: @c C:\Documents and Settings\@e username\Application Data\
-                 @e appname
-             @li Mac: @c ~/Library/Application Support/@e appname
+             - Unix: @c ~/.@e appname
+             - Windows: @c C:\\Documents @c and @c Settings\\@e username\Application Data\@e appname
+             - Mac: @c ~/Library/Application Support/@e appname
     */
     wxString GetUserDataDir() const;
 
     /**
         Return the directory for user data files which shouldn't be shared with
         the other machines.
-        This is the same as GetUserDataDir() for
-        all platforms except Windows where it returns
-        @c C:\Documents and Settings\@e username\Local Settings\Application Data\@e
-        appname
+        This is the same as GetUserDataDir() for all platforms except Windows where it returns
+        @c C:\\Documents @c and @c Settings\\@e username\\Local @c Settings\\Application @c Data\@e appname
     */
     wxString GetUserLocalDataDir() const;