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

Fix wxPATH_RMDIR_FULL documentation

Browse Source 
Explain what this flag really does in Rmdir() documentation itself, as
the old wording was confusing.

Closes #16682.
This commit is contained in:
Vadim Zeitlin
2021-09-13 21:05:21 +01:00
parent 8db2f45171
commit 8d13440d69
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
interface/wx/filename.h
View File

@@ -1225,9 +1225,12 @@ public:
Deletes the specified directory from the file system.
@param flags
Can contain one of wxPATH_RMDIR_FULL or wxPATH_RMDIR_RECURSIVE. By
default contains neither so the directory will not be removed
unless it is empty.
With default value, the directory is removed only if it is empty.
If wxPATH_RMDIR_FULL is specified, it is removed even if it
contains subdirectories, provided that there are no files in
neither this directory nor its subdirectories. If flags contains
wxPATH_RMDIR_RECURSIVE, then the directory is removed with all the
files and directories under it.
@return Returns @true if the directory was successfully deleted, @false
otherwise.
@@ -1240,9 +1243,12 @@ public:
@param dir
The directory to delete
@param flags
Can contain one of wxPATH_RMDIR_FULL or wxPATH_RMDIR_RECURSIVE. By
default contains neither so the directory will not be removed
unless it is empty.
With default value, the directory is removed only if it is empty.
If wxPATH_RMDIR_FULL is specified, it is removed even if it
contains subdirectories, provided that there are no files in
neither this directory nor its subdirectories. If flags contains
wxPATH_RMDIR_RECURSIVE, then the directory is removed with all the
files and directories under it.
@return Returns @true if the directory was successfully deleted, @false
otherwise.