From: Václav Slavík <vslavik@fastmail.fm>
Date: Tue, 10 May 2011 09:58:52 +0000 (+0000)
Subject: Clarify that wxFileName::GetPath() appends separator for toplevel dirs.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/76ba33d39af7b21b7e61eaa4595e221a6bb586a0

Clarify that wxFileName::GetPath() appends separator for toplevel dirs.

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

diff --git a/interface/wx/filename.h b/interface/wx/filename.h
index 07c94f0997..7bbd0cd527 100644
--- a/interface/wx/filename.h
+++ b/interface/wx/filename.h
@@ -611,6 +611,10 @@ public:
         Don't include the trailing separator in the returned string. This is
         the default (the value of this flag is 0) and exists only for symmetry
         with wxPATH_GET_SEPARATOR.
+
+        @note If the path is a toplevel one (e.g. @c "/" on Unix or @c "C:\" on
+              Windows), then the returned path will contain trailing separator
+              even with @c wxPATH_NO_SEPARATOR.
     */
     wxString GetPath(int flags = wxPATH_GET_VOLUME,
                      wxPathFormat format = wxPATH_NATIVE) const;