From: Václav Slavík <vslavik@fastmail.fm>
Date: Thu, 6 May 2010 18:28:31 +0000 (+0000)
Subject: Clarify that wxFileSystem::OpenFile() takes URL, not filename.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/81227455714950ea76cd6a82aa465d0b8dc4f29b

Clarify that wxFileSystem::OpenFile() takes URL, not filename.

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

diff --git a/interface/wx/filesys.h b/interface/wx/filesys.h
index bc311541f5..eb116eabcd 100644
--- a/interface/wx/filesys.h
+++ b/interface/wx/filesys.h
@@ -160,6 +160,11 @@ public:
         Passing @e "wxFS_READ | wxFS_SEEKABLE" for @a flags will back
         a stream that is not natively seekable with memory or a file
         and return a stream that is always seekable.
+
+        @note
+        The @a location argument is, despite this method's name @em not
+        a filename. It is a "location", aka wxFileSystem URL (see
+        @ref overview_fs).
     */
     wxFSFile* OpenFile(const wxString& location,
                        int flags = wxFS_READ);