Warn that normalizing a valid path may make it invalid sometimes.

Mention the special case of a path without file name and with directory that
normalizes to empty string.

See #10960.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66255 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/filename.h b/interface/wx/filename.h
index cadedb661be2f05051e4e8f83d5c5981969a64b1..c491cc4cb95b5c6c5e272b6a8eed09100d110217 100644 (file)
--- a/interface/wx/filename.h
+++ b/interface/wx/filename.h
@@ -962,9 +962,16 @@ public:
                       int flags = 0);
 
     /**
-        Normalize the path. With the default flags value, the path will be
-        made absolute, without any ".." and "." and all environment
-        variables will be expanded in it.
+        Normalize the path.
+
+        With the default flags value, the path will be made absolute, without
+        any ".." and "." and all environment variables will be expanded in it.
+
+        Notice that in some rare cases normalizing a valid path may result in
+        an invalid wxFileName object. E.g. normalizing "./" path using
+        wxPATH_NORM_DOTS but not wxPATH_NORM_ABSOLUTE will result in a
+        completely empty and thus invalid object. As long as there is a non
+        empty file name the result of normalization will be valid however.
 
         @param flags
             The kind of normalization to do with the file name. It can be