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

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'

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

20
interface/filefn.h
View File

@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: filefn.h
// Purpose: documentation for wxPathList class
// Purpose: interface of wxPathList
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -21,8 +21,7 @@
@library{wxbase}
@category{file}
@seealso
wxArrayString, wxStandardPaths, wxFileName
@see wxArrayString, wxStandardPaths, wxFileName
*/
class wxPathList : public wxArrayString
{
@@ -89,13 +88,14 @@ public:
Note in fact that wxPathList can be used to store both relative and absolute
paths so that
if you Added() relative paths, then the current working directory
(see wxGetCwd and wxSetWorkingDirectory)
(see wxGetCwd() and wxSetWorkingDirectory())
may affect the value returned by this function!
*/
wxString FindValidPath(const wxString& file) const;
};
// ============================================================================
// Global functions/macros
// ============================================================================
@@ -228,13 +228,13 @@ bool wxFileExists(const wxString& filename);
/**
Returns @true if the @a pattern matches the @e text; if @a dot_special is @true,
filenames beginning with a dot are not matched
with wildcard characters. See wxIsWild.
with wildcard characters. See wxIsWild().
*/
bool wxMatchWild(const wxString& pattern, const wxString& text,
bool dot_special);
/**
@b NB: This function is deprecated: use wxGetCwd instead.
@b NB: This function is deprecated: use wxGetCwd() instead.
Copies the current working directory into the buffer if supplied, or
copies the working directory into new storage (which you must delete
yourself) if the buffer is @NULL.
@@ -248,7 +248,7 @@ wxString wxGetWorkingDirectory(char* buf = NULL, int sz = 1000);
wxString wxPathOnly(const wxString& path);
/**
Returns @true if the pattern contains wildcards. See wxMatchWild.
Returns @true if the pattern contains wildcards. See wxMatchWild().
*/
bool wxIsWild(const wxString& pattern);
@@ -296,14 +296,14 @@ bool wxMkdir(const wxString& dir, int perm = 0777);
bool wxIsAbsolutePath(const wxString& filename);
/**
Returns the next file that matches the path passed to wxFindFirstFile.
See wxFindFirstFile for an example.
Returns the next file that matches the path passed to wxFindFirstFile().
See wxFindFirstFile() for an example.
*/
wxString wxFindNextFile();
/**
This function does directory searching; returns the first file
that matches the path @e spec, or the empty string. Use wxFindNextFile to
that matches the path @e spec, or the empty string. Use wxFindNextFile() to
get the next matching file. Neither will report the current directory "." or the
parent directory "..".
*/