Improvements to application info documentation in wxStandardPaths.

Use "appinfo" instead of "appname" in the examples to make it clear that it
may be different from just the application name.

Also make UseAppInfo() documentation more clear.

See #11275.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62336 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2009-10-08 22:37:53 +00:00
parent 411a1c35ff
commit 4f83b9fc54

View File

@ -15,11 +15,11 @@
In the description of the methods below, the example return values are given In the description of the methods below, the example return values are given
for the Unix, Windows and Mac OS X systems, however please note that these are for the Unix, Windows and Mac OS X systems, however please note that these are
just the examples and the actual values may differ. For example, under Windows: just the examples and the actual values may differ. For example, under Windows:
the system administrator may change the standard directories locations, i.e. the system administrator may change the standard directories locations, e.g.
the Windows directory may be named @c "W:\Win2003" instead of the Windows directory may be named @c "W:\Win2003" instead of
the default @c "C:\Windows". the default @c "C:\Windows".
Notice that in the examples below the string @c appname may be either just Notice that in the examples below the string @c appinfo may be either just
the application name (as returned by wxApp::GetAppName()) or a combination the application name (as returned by wxApp::GetAppName()) or a combination
of the vendor name (wxApp::GetVendorName()) and the application name, with of the vendor name (wxApp::GetVendorName()) and the application name, with
a path separator between them. By default, the vendor name is used under a path separator between them. By default, the vendor name is used under
@ -79,9 +79,9 @@ public:
returns GetDocumentsDir(). returns GetDocumentsDir().
Example return values: Example return values:
- Unix: @c ~/appname - Unix: @c ~/appinfo
- Windows: @c "C:\Documents and Settings\username\My Documents\appname" - Windows: @c "C:\Documents and Settings\username\My Documents\appinfo"
- Mac: @c ~/Documents/appname - Mac: @c ~/Documents/appinfo
@since 2.9.0 @since 2.9.0
@ -104,9 +104,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:
- Unix: @c prefix/share/appname - Unix: @c prefix/share/appinfo
- Windows: the directory where the executable file is located - Windows: the directory where the executable file is located
- Mac: @c appname.app/Contents/SharedSupport bundle subdirectory - Mac: @c appinfo.app/Contents/SharedSupport bundle subdirectory
@see GetLocalDataDir() @see GetLocalDataDir()
*/ */
@ -150,7 +150,7 @@ public:
Return the location for application data files which are host-specific and Return the location for application data files which are host-specific and
can't, or shouldn't, be shared with the other machines. can't, or shouldn't, be shared with the other machines.
This is the same as GetDataDir() except under Unix where it returns @c /etc/appname. This is the same as GetDataDir() except under Unix where it returns @c /etc/appinfo.
*/ */
virtual wxString GetLocalDataDir() const; virtual wxString GetLocalDataDir() const;
@ -171,9 +171,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:
- Unix: @c prefix/lib/appname - Unix: @c prefix/lib/appinfo
- Windows: the directory of the executable file - Windows: the directory of the executable file
- Mac: @c appname.app/Contents/PlugIns bundle subdirectory - Mac: @c appinfo.app/Contents/PlugIns bundle subdirectory
@see wxDynamicLibrary @see wxDynamicLibrary
*/ */
@ -187,9 +187,9 @@ public:
This function is the same as GetDataDir() for all platforms except Mac OS X. This function is the same as GetDataDir() for all platforms except Mac OS X.
Example return values: Example return values:
- Unix: @c prefix/share/appname - Unix: @c prefix/share/appinfo
- Windows: the directory where the executable file is located - Windows: the directory where the executable file is located
- Mac: @c appname.app/Contents/Resources bundle subdirectory - Mac: @c appinfo.app/Contents/Resources bundle subdirectory
@since 2.7.0 @since 2.7.0
@ -219,9 +219,9 @@ public:
/** /**
Return the directory for the user-dependent application data files: Return the directory for the user-dependent application data files:
- Unix: @c ~/.appname - Unix: @c ~/.appinfo
- Windows: @c "C:\Documents and Settings\username\Application Data\appname" - Windows: @c "C:\Documents and Settings\username\Application Data\appinfo"
- Mac: @c "~/Library/Application Support/appname" - Mac: @c "~/Library/Application Support/appinfo"
*/ */
virtual wxString GetUserDataDir() const; virtual wxString GetUserDataDir() const;
@ -230,7 +230,7 @@ public:
the other machines. the other machines.
This is the same as GetUserDataDir() for all platforms except Windows where it returns This is the same as GetUserDataDir() for all platforms except Windows where it returns
@c "C:\Documents and Settings\username\Local Settings\Application Data\appname" @c "C:\Documents and Settings\username\Local Settings\Application Data\appinfo"
*/ */
virtual wxString GetUserLocalDataDir() const; virtual wxString GetUserLocalDataDir() const;
@ -319,9 +319,13 @@ public:
should be unique to this program, such as the application data directory, the should be unique to this program, such as the application data directory, the
plugins directory on Unix, etc. plugins directory on Unix, etc.
Valid values for @a info are @c AppInfo_None and either one or combination Valid values for @a info are:
of @c AppInfo_AppName and @c AppInfo_VendorName. The first one tells this - @c AppInfo_None: don't use neither application nor vendor name in
class to not use neither application nor vendor name in the paths. the paths.
- @c AppInfo_AppName: use the application name in the paths.
- @c AppInfo_VendorName: use the vendor name in the paths, usually
used combined with AppInfo_AppName, i.e. as @code AppInfo_AppName |
AppInfo_VendorName @endcode
By default, only the application name is used under Unix systems but both By default, only the application name is used under Unix systems but both
application and vendor names are used under Windows and Mac. application and vendor names are used under Windows and Mac.