regenerated headers to remove @seealso in favour of @see; fixed links to global functions/macros; converted \since latex macros into @wxsince commands; changed headers purpose from 'documentation for' to 'interface of'

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-10 15:24:38 +00:00
parent 3a65144e7c
commit e54c96f187
269 changed files with 2027 additions and 1553 deletions

View File

@@ -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
{
@@ -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;
@@ -147,7 +148,8 @@ 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()
*/
@@ -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);
};