X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..ea58aac5808a7617dd68c94b651ad70e038a324f:/interface/stdpaths.h diff --git a/interface/stdpaths.h b/interface/stdpaths.h index 365a2846c7..2ca093e698 100644 --- a/interface/stdpaths.h +++ b/interface/stdpaths.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stdpaths.h -// Purpose: documentation for wxStandardPaths class +// Purpose: interface of wxStandardPaths // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -41,8 +41,7 @@ @library{wxbase} @category{file} - @seealso - wxFileConfig + @see wxFileConfig */ class wxStandardPaths { @@ -58,7 +57,7 @@ public: Unix: @c /etc Windows: @c C:\Documents and Settings\All Users\Application Data Mac: @c /Library/Preferences - + @see wxFileConfig */ wxString GetConfigDir() const; @@ -70,7 +69,7 @@ public: Unix: @c @e prefix/share/@e appname Windows: the directory where the executable file is located Mac: @c @e appname.app/Contents/SharedSupport bundle subdirectory - + @see GetLocalDataDir() */ wxString GetDataDir() const; @@ -81,7 +80,8 @@ public: Unix: @c ~ (the home directory) Windows: @c C:\Documents and Settings\@e username\Documents Mac: @c ~/Documents - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ wxString GetDocumentsDir() const; @@ -121,7 +121,8 @@ public: @c @e lang.lproj under Mac OS X) but is something quite different for message catalog category under Unix where it returns the standard @c @e prefix/share/locale/@e lang/LC_MESSAGES directory. - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ wxString GetLocalizedResourcesDir(const wxString& lang, ResourceCat category = ResourceCat_None) const; @@ -132,7 +133,7 @@ public: 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 */ wxString GetPluginsDir() const; @@ -147,8 +148,9 @@ public: 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 - This function is new since wxWidgets version 2.7.0 - + + @wxsince{2.7.0} + @see GetLocalizedResourcesDir() */ wxString GetResourcesDir() const; @@ -158,7 +160,8 @@ public: files, it is best to use wxFileName::CreateTempFileName for correct behaviour when multiple processes are attempting to create temporary files. - This function is new since wxWidgets version 2.7.2 + + @wxsince{2.7.2} */ wxString GetTempDir() const; @@ -217,3 +220,4 @@ public: */ void UseAppInfo(int info); }; +