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

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
interface/filefn.h
View File

@@ -40,15 +40,12 @@ public:
The first form adds the given directory to the path list, if the path is not
already in the list.
If the path cannot be normalized for some reason, it returns @false.
The second form just calls the first form on all elements of the given array.
The @e path is always considered a directory but no existence checks will be
The @a path is always considered a directory but no existence checks will be
done on it
(because if it doesn't exist, it could be created later and thus result a valid
path when
FindValidPath() is called).
@b Note: if the given path is relative, it won't be made absolute before adding
it
(this is why FindValidPath() may return relative paths).
@@ -82,15 +79,12 @@ public:
Searches the given file in all paths stored in this class.
The first path which concatenated to the given string points to an existing
file (see @ref wxFile::exists wxFileExists) is returned.
If the file wasn't found in any of the stored paths, an empty string is
returned.
The given string must be a file name, eventually with a path prefix (if the path
prefix is absolute, only its name will be searched); i.e. it must not end with
a directory separator (see wxFileName::GetPathSeparator)
otherwise an assertion will fail.
The returned path may be relative to the current working directory.
Note in fact that wxPathList can be used to store both relative and absolute
paths so that
@@ -108,13 +102,13 @@ public:
/**
This function returns the total number of bytes and number of free bytes on
the disk containing the directory @e path (it should exist). Both
@e total and @e free parameters may be @NULL if the corresponding
the disk containing the directory @a path (it should exist). Both
@a total and @a free parameters may be @NULL if the corresponding
information is not needed.
*/
bool wxGetDiskSpace(const wxString& path,
wxLongLong total = @NULL,
wxLongLong free = @NULL);
wxLongLong total = NULL,
wxLongLong free = NULL);
/**
Returns the Windows directory under Windows; on other platforms returns the
@@ -128,7 +122,7 @@ wxString wxGetOSDirectory();
The arrays will contain an equal number of items found before the error.
On platforms where native dialogs handle only one filter per entry,
entries in arrays are automatically adjusted.
@e wildCard is in the form:
@a wildCard is in the form:
@code
"All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
@@ -140,40 +134,35 @@ int wxParseCommonDialogsFilter(const wxString& wildCard,
/**
This function is deprecated, use wxFileName instead.
Converts a Unix to a DOS filename by replacing forward
slashes with backslashes.
*/
void wxUnix2DosFilename(wxChar * s);
void wxUnix2DosFilename(wxChar* s);
/**
Returns @true if @e dirname exists and is a directory.
Returns @true if @a dirname exists and is a directory.
*/
bool wxDirExists(const wxString& dirname);
/**
@b NB: This function is obsolete, please use
wxFileName::SplitPath instead.
This function splits a full file name into components: the path (including
possible disk/drive
specification under Windows), the base name and the extension. Any of the
output parameters
(@e path, @e name or @e ext) may be @NULL if you are not interested in the value
(@e path, @a name or @e ext) may be @NULL if you are not interested in the value
of
a particular component.
wxSplitPath() will correctly handle filenames with both DOS and Unix path
separators under
Windows, however it will not consider backslashes as path separators under Unix
(where backslash
is a valid character in a filename).
On entry, @e fullname should be non-@NULL (it may be empty though).
On return, @e path contains the file path (without the trailing separator), @e
On entry, @a fullname should be non-@NULL (it may be empty though).
On return, @a path contains the file path (without the trailing separator), @e
name
contains the file name and @e ext contains the file extension without leading
contains the file name and @a ext contains the file extension without leading
dot. All
three of them may be empty if the corresponding component is. The old contents
of the
@@ -181,23 +170,21 @@ bool wxDirExists(const wxString& dirname);
pointers
are not @NULL).
*/
void wxSplitPath(const wxString& fullname, wxString * path,
wxString * name,
wxString * ext);
void wxSplitPath(const wxString& fullname, wxString* path,
wxString* name,
wxString* ext);
/**
Under Unix this macro changes the current process umask to the given value,
unless it is equal to -1 in which case nothing is done, and restores it to
the original value on scope exit. It works by declaring a variable which sets
umask to @e mask in its constructor and restores it in its destructor.
umask to @a mask in its constructor and restores it in its destructor.
Under other platforms this macro expands to nothing.
*/
#define wxCHANGE_UMASK(int mask) /* implementation is private */
/**
Returns time of last modification of given file.
The function returns @c (time_t)-1 if an error occurred (e.g. file not
found).
*/
@@ -207,34 +194,31 @@ time_t wxFileModificationTime(const wxString& filename);
/**
@b NB: This function is obsolete, please use
wxFileName::SplitPath instead.
Returns the filename for a full path. The second form returns a pointer to
temporary storage that should not be deallocated.
*/
wxString wxFileNameFromPath(const wxString& path);
char * wxFileNameFromPath(char * path);
char* wxFileNameFromPath(char* path);
//@}
/**
Renames @e file1 to @e file2, returning @true if successful.
If @e overwrite parameter is @true (default), the destination file is
overwritten if it exists, but if @e overwrite is @false, the functions fails
Renames @a file1 to @e file2, returning @true if successful.
If @a overwrite parameter is @true (default), the destination file is
overwritten if it exists, but if @a overwrite is @false, the functions fails
in this case.
*/
bool wxRenameFile(const wxString& file1, const wxString& file2,
bool overwrite = @true);
bool overwrite = true);
/**
Copies @e file1 to @e file2, returning @true if successful. If
@e overwrite parameter is @true (default), the destination file is overwritten
if it exists, but if @e overwrite is @false, the functions fails in this
Copies @a file1 to @e file2, returning @true if successful. If
@a overwrite parameter is @true (default), the destination file is overwritten
if it exists, but if @a overwrite is @false, the functions fails in this
case.
This function supports resources forks under Mac OS.
*/
bool wxCopyFile(const wxString& file1, const wxString& file2,
bool overwrite = @true);
bool overwrite = true);
/**
Returns @true if the file exists and is a plain file.
@@ -242,7 +226,7 @@ bool wxCopyFile(const wxString& file1, const wxString& file2,
bool wxFileExists(const wxString& filename);
/**
Returns @true if the @e pattern matches the @e text; if @e dot_special is @true,
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.
*/
@@ -251,14 +235,12 @@ bool wxMatchWild(const wxString& pattern, const wxString& text,
/**
@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.
@e sz is the size of the buffer if supplied.
@a sz is the size of the buffer if supplied.
*/
wxString wxGetWorkingDirectory(char * buf=@NULL, int sz=1000);
wxString wxGetWorkingDirectory(char* buf = NULL, int sz = 1000);
/**
Returns the directory part of the filename.
@@ -279,10 +261,10 @@ wxString wxGetCwd();
Converts a DOS to a Unix filename by replacing backslashes with forward
slashes.
*/
void wxDos2UnixFilename(wxChar * s);
void wxDos2UnixFilename(wxChar* s);
/**
Concatenates @e file1 and @e file2 to @e file3, returning
Concatenates @a file1 and @a file2 to @e file3, returning
@true if successful.
*/
bool wxConcatFiles(const wxString& file1, const wxString& file2,
@@ -295,15 +277,14 @@ bool wxRemoveFile(const wxString& file);
/**
Sets the current working directory, returning @true if the operation succeeded.
Under MS Windows, the current drive is also changed if @e dir contains a drive
Under MS Windows, the current drive is also changed if @a dir contains a drive
specification.
*/
bool wxSetWorkingDirectory(const wxString& dir);
/**
Makes the directory @e dir, returning @true if successful.
@e perm is the access mask for the directory for the systems on which it is
@a perm is the access mask for the directory for the systems on which it is
supported (Unix) and doesn't have any effect on the other ones.
*/
bool wxMkdir(const wxString& dir, int perm = 0777);
@@ -316,7 +297,6 @@ bool wxIsAbsolutePath(const wxString& filename);
/**
Returns the next file that matches the path passed to wxFindFirstFile.
See wxFindFirstFile for an example.
*/
wxString wxFindNextFile();
@@ -332,6 +312,7 @@ wxString wxFindFirstFile(const wxString& spec, int flags = 0);
//@{
/**
Returns the type of an open file. Possible return values are:
@code
enum wxFileKind
{
@@ -343,7 +324,7 @@ wxString wxFindFirstFile(const wxString& spec, int flags = 0);
@endcode
*/
wxFileKind wxGetFileKind(int fd);
wxFileKind wxGetFileKind(FILE * fp);
wxFileKind wxGetFileKind(FILE* fp);
//@}
//@{
@@ -352,20 +333,18 @@ wxFileKind wxGetFileKind(FILE * fp);
wxFileName::CreateTempFileName
instead.
*/
char * wxGetTempFileName(const wxString& prefix, char * buf=@NULL);
char* wxGetTempFileName(const wxString& prefix, char* buf = NULL);
bool wxGetTempFileName(const wxString& prefix, wxString& buf);
//@}
/**
Removes the directory @e dir, returning @true if successful. Does not work under
VMS.
The @e flags parameter is reserved for future use.
The @a flags parameter is reserved for future use.
Please notice that there is also a wxRmDir() function which simply wraps the
standard POSIX rmdir() function and so return an integer error code instead of
a boolean value (but otherwise is currently identical to wxRmdir), don't
confuse these two functions.
*/
bool wxRmdir(const wxString& dir, int flags=0);
bool wxRmdir(const wxString& dir, int flags = 0);