Fix wxGetDiskSpace() documentation

The function is actually declared in utils.h and not in filefn.h
This commit is contained in:
Tobias Taschner
2018-10-31 10:26:11 +01:00
parent 8c99df373a
commit 394b26bc36
2 changed files with 20 additions and 20 deletions

View File

@@ -365,6 +365,26 @@ wxPowerType wxGetPowerType();
*/
wxString wxGetDisplayName();
/**
This function returns the total number of bytes and number of free bytes on
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.
@since 2.3.2
@note The generic Unix implementation depends on the system having the
@c statfs() or @c statvfs() function.
@return @true on success, @false if an error occurred (for example, the
directory doesnt exist).
@header{wx/utils.h}
*/
bool wxGetDiskSpace(const wxString& path,
wxLongLong total = NULL,
wxLongLong free = NULL);
/**
For normal keys, returns @true if the specified key is currently down.