clarified the parameters of MB2WC and WC2MB a little in the docs/headers

[wxWidgets.git] / docs / latex / wx / url.tex

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index c1515239d93ef383cd1c7cb04708fb3b303e6553..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}}
 
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -89,7 +93,7 @@ It can be one of these errors:
 \twocolitem{{\bf wxURL\_NOHOST}}{An host name is required for this protocol.}
 \twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.}
 \twocolitem{{\bf wxURL\_CONNERR}}{Connection error.}
 \twocolitem{{\bf wxURL\_NOHOST}}{An host name is required for this protocol.}
 \twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.}
 \twocolitem{{\bf wxURL\_CONNERR}}{Connection error.}

-\twocolitem{{\bf wxURL\_PROTOERR}}{An error occured during negotiation.}
+\twocolitem{{\bf wxURL\_PROTOERR}}{An error occurred during negotiation.}

 \end{twocollist}%
 
 %
 \end{twocollist}%
 
 %


@@ -100,7 +104,7 @@ It can be one of these errors:
 \func{wxInputStream *}{GetInputStream}{\void}
 
 Creates a new input stream on the the specified URL. You can use all but seek
 \func{wxInputStream *}{GetInputStream}{\void}
 
 Creates a new input stream on the the specified URL. You can use all but seek

-functionnality of wxStream. Seek isn't available on all stream. For example,
+functionality of wxStream. Seek isn't available on all stream. For example,

 http or ftp streams doesn't deal with it.
 
 \wxheading{Return value}
 http or ftp streams doesn't deal with it.
 
 \wxheading{Return value}