Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Try out - instead of @li, more backslash escaping

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53146 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2008-04-12 19:34:32 +00:00
parent 35f860fa23
commit ad51d1c8e9
1 changed files with 26 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
interface/stdpaths.h
View File

@@ -54,9 +54,9 @@ public:
/** /**
Return the directory containing the system config files. Return the directory containing the system config files.
Example return values: Example return values:
@li Unix: @c /etc - Unix: @c /etc
@li Windows: @c C:\\Documents and Settings\\All Users\\Application Data - Windows: @c C:\\Documents @c and @c Settings\\All Users\\Application Data
@li Mac: @c /Library/Preferences - Mac: @c /Library/Preferences
@see wxFileConfig @see wxFileConfig
*/ */
@@ -66,9 +66,9 @@ public:
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. data files.
Example return values: Example return values:
@li Unix: @c prefix/share/appname - Unix: @c prefix/share/@e appname
@li Windows: the directory where the executable file is located - Windows: the directory where the executable file is located
@li Mac: @c appname.app/Contents/SharedSupport bundle subdirectory - Mac: @c @e appname.app/Contents/SharedSupport bundle subdirectory
@see GetLocalDataDir() @see GetLocalDataDir()
*/ */
@@ -77,9 +77,9 @@ public:
/** /**
Return the directory containing the current user's documents. Return the directory containing the current user's documents.
Example return values: Example return values:
@li Unix: @c ~ (the home directory) - Unix: @c ~ (the home directory)
@li Windows: @c C:\\Documents and Settings\\username\\Documents - Windows: @c C:\\Documents @c and @c Settings\\@e username\\Documents
@li Mac: @c ~/Documents - Mac: @c ~/Documents
@wxsince{2.7.0} @wxsince{2.7.0}
*/ */
@@ -88,9 +88,9 @@ public:
/** /**
Return the directory and the filename for the current executable. Return the directory and the filename for the current executable.
Example return values: Example return values:
@li Unix: @c /usr/local/bin/exename - Unix: @c /usr/local/bin/@e exename
@li Windows: @c C:\\Programs\\AppFolder\\exename.exe - Windows: @c C:\\Programs\\AppFolder\\@e exename.exe
@li Mac: @c /Programs/exename - Mac: @c /Programs/@e exename
*/ */
wxString GetExecutablePath() const; wxString GetExecutablePath() const;
@@ -128,9 +128,9 @@ public:
/** /**
Return the directory where the loadable modules (plugins) live. Return the directory where the loadable modules (plugins) live.
Example return values: Example return values:
@li Unix: @c @e prefix/lib/@e appname - Unix: @c @e prefix/lib/@e appname
@li Windows: the directory of the executable file - Windows: the directory of the executable file
@li Mac: @c @e appname.app/Contents/PlugIns bundle subdirectory - Mac: @c @e appname.app/Contents/PlugIns bundle subdirectory
@see wxDynamicLibrary @see wxDynamicLibrary
*/ */
@@ -143,9 +143,9 @@ public:
This function is the same as GetDataDir() for This function is the same as GetDataDir() for
all platforms except Mac OS X. all platforms except Mac OS X.
Example return values: Example return values:
@li Unix: @c @e prefix/share/@e appname - Unix: @c @e prefix/share/@e appname
@li Windows: the directory where the executable file is located - Windows: the directory where the executable file is located
@li Mac: @c @e appname.app/Contents/Resources bundle subdirectory - Mac: @c @e appname.app/Contents/Resources bundle subdirectory
@wxsince{2.7.0} @wxsince{2.7.0}
@@ -165,9 +165,9 @@ public:
/** /**
Return the directory for the user config files: Return the directory for the user config files:
@li Unix: @c ~ (the home directory) - Unix: @c ~ (the home directory)
@li Windows: @c C:\Documents and Settings\@e username\Application Data - Windows: @c C:\\Documents @c and @c Settings\\@e username\\Application Data
@li Mac: @c ~/Library/Preferences - Mac: @c ~/Library/Preferences
Only use this method if you have a single configuration file to put in this Only use this method if you have a single configuration file to put in this
directory, otherwise GetUserDataDir() is directory, otherwise GetUserDataDir() is
more appropriate. more appropriate.
@@ -176,20 +176,17 @@ public:
/** /**
Return the directory for the user-dependent application data files: Return the directory for the user-dependent application data files:
@li Unix: @c ~/.@e appname - Unix: @c ~/.@e appname
@li Windows: @c C:\Documents and Settings\@e username\Application Data\ - Windows: @c C:\\Documents @c and @c Settings\\@e username\Application Data\@e appname
@e appname - Mac: @c ~/Library/Application Support/@e appname
@li Mac: @c ~/Library/Application Support/@e appname
*/ */
wxString GetUserDataDir() const; wxString GetUserDataDir() const;
/** /**
Return the directory for user data files which shouldn't be shared with Return the directory for user data files which shouldn't be shared with
the other machines. the other machines.
This is the same as GetUserDataDir() for This is the same as GetUserDataDir() for all platforms except Windows where it returns
all platforms except Windows where it returns @c C:\\Documents @c and @c Settings\\@e username\\Local @c Settings\\Application @c Data\@e appname
@c C:\Documents and Settings\@e username\Local Settings\Application Data\@e
appname
*/ */
wxString GetUserLocalDataDir() const; wxString GetUserLocalDataDir() const;