cross-reference types in the generated docs (patch 1038083)

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index 59a734a6801766295d2fa025ce503006f5ebc2c0..7452671911f0abc5e3ff99f64fba986eddb0660a 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -17,16 +17,6 @@ and comparison operators.
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
 
-\wxheading{Example}
-
-\begin{verbatim}
-  wxURL url("http://a.host/a.dir/a.file");
-  wxInputStream *in_stream;
-
-  in_stream = url.GetInputStream();
-  // Then, you can use all IO calls of in_stream (See wxStream)
-\end{verbatim}
-
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
@@ -53,15 +43,6 @@ contain three consecutive slashes.
 
 Destroys the URL object.
 
-%
-% GetProtocolName
-%
-\membersection{wxURL::GetProtocolName}\label{wxurlgetprotocolname}
-
-\constfunc{wxString}{GetProtocolName}{\void}
-
-Returns the name of the protocol which will be used to get the URL.
-
 %
 % GetProtocol
 %
@@ -71,15 +52,6 @@ Returns the name of the protocol which will be used to get the URL.
 
 Returns a reference to the protocol which will be used to get the URL.
 
-%
-% GetPath
-%
-\membersection{wxURL::GetPath}\label{wxurlgetpath}
-
-\func{wxString}{GetPath}{\void}
-
-Returns the path of the file to fetch. This path was encoded in the URL.
-
 %
 % GetError
 %
@@ -112,6 +84,22 @@ Creates a new input stream on the the specified URL. You can use all but seek
 functionality of wxStream. Seek isn't available on all stream. For example,
 http or ftp streams doesn't deal with it.
 
+Note that this method is somewhat depreciated, all future wxWidgets applications
+should really use \helpref{wxFileSystem}{wxfilesystem} instead.
+
+Example:
+
+\begin{verbatim}
+  wxURL url("http://a.host/a.dir/a.file");
+  if (url.GetError() == wxURL_NOERR)
+  {
+      wxInputStream *in_stream;
+
+      in_stream = url.GetInputStream();
+      // Then, you can use all IO calls of in_stream (See wxStream)
+  }
+\end{verbatim}
+
 \wxheading{Return value}
 
 Returns the initialized stream. You will have to delete it yourself.
@@ -151,13 +139,3 @@ Sets the proxy to use for this URL.
 
 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
 
-%
-% SetProxy
-%
-\membersection{wxURL::ConvertToValidURI}\label{wxurlconverttovaliduri}
-
-\func{static wxString}{ConvertToValidURI}{\param{const wxString\&}{ uri}}
-
-It converts a non-standardized URI to a valid network URI. It encodes non
-standard characters.
-