docstring fixes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_8_BRANCH@46277 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -32,7 +32,7 @@ given for the Unix, Windows and Mac OS X systems, however please note
|
|||||||
that these are just examples and the actual values may differ. For
|
that these are just examples and the actual values may differ. For
|
||||||
example, under Windows the system administrator may change the
|
example, under Windows the system administrator may change the
|
||||||
standard directories locations, i.e. the Windows directory may be
|
standard directories locations, i.e. the Windows directory may be
|
||||||
named W:\Win2003 instead of the default C:\Windows.
|
named W:/Win2003 instead of the default C:/Windows.
|
||||||
|
|
||||||
The strings appname and username should be replaced with the value
|
The strings appname and username should be replaced with the value
|
||||||
returned by `wx.App.GetAppName` and the name of the currently logged
|
returned by `wx.App.GetAppName` and the name of the currently logged
|
||||||
@@ -85,14 +85,14 @@ absolute path whenever possible.", "");
|
|||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
virtual wxString , GetConfigDir() const,
|
virtual wxString , GetConfigDir() const,
|
||||||
"Return the directory with system config files: /etc under Unix,
|
"Return the directory with system config files: /etc under Unix,
|
||||||
'c:\\Documents and Settings\\All Users\\Application Data' under Windows,
|
'c:/Documents and Settings/All Users/Application Data' under Windows,
|
||||||
/Library/Preferences for Mac", "");
|
/Library/Preferences for Mac", "");
|
||||||
|
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
virtual wxString , GetUserConfigDir() const,
|
virtual wxString , GetUserConfigDir() const,
|
||||||
"Return the directory for the user config files: $HOME under Unix,
|
"Return the directory for the user config files: $HOME under Unix,
|
||||||
'c:\\Documents and Settings\\username' under Windows, and
|
'c:/Documents and Settings/username' under Windows, and
|
||||||
~/Library/Preferences under Mac
|
~/Library/Preferences under Mac
|
||||||
|
|
||||||
Only use this if you have a single file to put there, otherwise
|
Only use this if you have a single file to put there, otherwise
|
||||||
@@ -103,7 +103,7 @@ Only use this if you have a single file to put there, otherwise
|
|||||||
virtual wxString , GetDataDir() const,
|
virtual wxString , GetDataDir() const,
|
||||||
"Return the location of the application's global, (i.e. not
|
"Return the location of the application's global, (i.e. not
|
||||||
user-specific,) data files: prefix/share/appname under Unix,
|
user-specific,) data files: prefix/share/appname under Unix,
|
||||||
'c:\\Program Files\\appname' under Windows,
|
'c:/Program Files/appname' under Windows,
|
||||||
appname.app/Contents/SharedSupport app bundle directory under Mac.", "");
|
appname.app/Contents/SharedSupport app bundle directory under Mac.", "");
|
||||||
|
|
||||||
|
|
||||||
@@ -117,8 +117,8 @@ host-specific. Same as `GetDataDir` except under Unix where it is
|
|||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
virtual wxString , GetUserDataDir() const,
|
virtual wxString , GetUserDataDir() const,
|
||||||
"Return the directory for the user-dependent application data files:
|
"Return the directory for the user-dependent application data files:
|
||||||
$HOME/.appname under Unix, c:\\Documents and
|
$HOME/.appname under Unix, c:/Documents and
|
||||||
Settings\\username\\Application Data\\appname under Windows and
|
Settings/username/Application Data/appname under Windows and
|
||||||
~/Library/Application Support/appname under Mac", "");
|
~/Library/Application Support/appname under Mac", "");
|
||||||
|
|
||||||
|
|
||||||
@@ -128,7 +128,7 @@ Settings\\username\\Application Data\\appname under Windows and
|
|||||||
with the other machines
|
with the other machines
|
||||||
|
|
||||||
Same as `GetUserDataDir` for all platforms except Windows where it is
|
Same as `GetUserDataDir` for all platforms except Windows where it is
|
||||||
the 'Local Settings\\Application Data\\appname' directory.", "");
|
the 'Local Settings/Application Data/appname' directory.", "");
|
||||||
|
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
@@ -168,7 +168,7 @@ standard prefix/share/locale/lang/LC_MESSAGES.)", "");
|
|||||||
virtual wxString , GetDocumentsDir() const,
|
virtual wxString , GetDocumentsDir() const,
|
||||||
"Return the Documents directory for the current user.
|
"Return the Documents directory for the current user.
|
||||||
|
|
||||||
C:\Documents and Settings\username\Documents under Windows,
|
C:/Documents and Settings/username/Documents under Windows,
|
||||||
$HOME under Unix and ~/Documents under Mac", "");
|
$HOME under Unix and ~/Documents under Mac", "");
|
||||||
|
|
||||||
DocDeclStr(
|
DocDeclStr(
|
||||||
|
Reference in New Issue
Block a user