From 8d13440d69bb4f1283f528cf8f6ee35b08555c73 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 13 Sep 2021 21:05:21 +0100 Subject: [PATCH] Fix wxPATH_RMDIR_FULL documentation Explain what this flag really does in Rmdir() documentation itself, as the old wording was confusing. Closes #16682. --- interface/wx/filename.h | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/interface/wx/filename.h b/interface/wx/filename.h index 7dc34abdac..1eed1b4b0d 100644 --- a/interface/wx/filename.h +++ b/interface/wx/filename.h @@ -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.