Mention RFC 1738, in particular file://hostname/path/to/file

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index 13aca8fe80ca47372f7e1ada2ebaad6020dd4d75..7c1a4a3b7ee4fbd195d92a750dd37db9dabfbec1 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -32,7 +32,11 @@
 
 \func{}{wxURL}{\param{const wxString\&}{ url}}
 
-Constructs an URL object from the string.
+Constructs a URL object from the string.  The URL must be valid according
+to RFC 1738.  In particular, file URLs must be of the format
+'file://hostname/path/to/file'.  It is valid to leave out the hostname
+but slashes must remain in place-- i.e. a file URL without a hostname must
+contain three consecutive slashes.
 
 \wxheading{Parameters}