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

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

diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex
index 6cb94ad996ba4c024e1418401c037df4b6541eb5..8c8b0f62152ea1c40fd0529bff80c1f305a3eb6b 100644 (file)
--- a/docs/latex/wx/filesys.tex
+++ b/docs/latex/wx/filesys.tex
@@ -53,34 +53,34 @@ care about it.
 
 \membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto}
 
 
 \membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto}
 

-\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = FALSE}}
+\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = false}}

 
 Sets the current location. {\it location} parameter passed to 
 \helpref{OpenFile}{wxfilesystemopenfile} is relative to this path.
 
 
 Sets the current location. {\it location} parameter passed to 
 \helpref{OpenFile}{wxfilesystemopenfile} is relative to this path.
 

-{\bf Caution! } Unless {\it is\_dir} is TRUE the {\it location} parameter
-is not directory name but the name of the file in this directory!! All these
-commands change path to "dir/subdir/" :
+{\bf Caution! } Unless {\it is\_dir} is true the {\it location} parameter
+is not the directory name but the name of the file in this directory. All these
+commands change the path to "dir/subdir/":

 
 \begin{verbatim}
 
 \begin{verbatim}

-ChangePathTo("dir/subdir/xh.htm");
-ChangePathTo("dir/subdir", TRUE);
-ChangePathTo("dir/subdir/", TRUE);
+  ChangePathTo("dir/subdir/xh.htm");
+  ChangePathTo("dir/subdir", true);
+  ChangePathTo("dir/subdir/", true);

 \end{verbatim}
 
 \wxheading{Parameters}
 
 \end{verbatim}
 
 \wxheading{Parameters}
 

-\docparam{location}{the new location. Its meaning depends on value of {\it is\_dir}}
+\docparam{location}{the new location. Its meaning depends on the value of {\it is\_dir}}

 
 

-\docparam{is\_dir}{if TRUE {\it location} is new directory. If FALSE (default)
+\docparam{is\_dir}{if true {\it location} is new directory. If false (default) 

 {\it location} is {\bf file in} the new directory.}
 
 \wxheading{Example}
 
 \begin{verbatim}
 {\it location} is {\bf file in} the new directory.}
 
 \wxheading{Example}
 
 \begin{verbatim}

-f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm'
-fs -> ChangePathTo("subdir/folder", TRUE);
-f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !!
+  f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm'
+  fs -> ChangePathTo("subdir/folder", true);
+  f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !!

 \end{verbatim}
 
 \membersection{wxFileSystem::GetPath}\label{wxfilesystemgetpath}
 \end{verbatim}
 
 \membersection{wxFileSystem::GetPath}\label{wxfilesystemgetpath}


@@ -112,26 +112,27 @@ wxFILE (only files), wxDIR (only directories) or 0 (both).
 
 \func{wxString}{FindNext}{\void}
 
 
 \func{wxString}{FindNext}{\void}
 

-Returns next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}.
-
+Returns the next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}.

 
 \membersection{wxFileSystem::OpenFile}\label{wxfilesystemopenfile}
 
 \func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}}
 
 
 \membersection{wxFileSystem::OpenFile}\label{wxfilesystemopenfile}
 
 \func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}}
 

-Opens file and returns pointer to \helpref{wxFSFile}{wxfsfile} object
+Opens the file and returns a pointer to a \helpref{wxFSFile}{wxfsfile} object

 or NULL if failed. It first tries to open the file in relative scope
 (based on value passed to ChangePathTo() method) and then as an
 or NULL if failed. It first tries to open the file in relative scope
 (based on value passed to ChangePathTo() method) and then as an

-absolute path.
+absolute path.  Note that the user is responsible for deleting the returned
+wxFSFile.  

 
 \membersection{wxFileSystem::URLToFileName}\label{wxfilesystemurltofilename}
 
 
 \membersection{wxFileSystem::URLToFileName}\label{wxfilesystemurltofilename}
 

-\func{static wxFileName}{URLToFileName}{\param{const wxString& }{url}}
+\func{static wxFileName}{URLToFileName}{\param{const wxString\& }{url}}

 
 

-Converts URL into well-formed filename. The URL must use {\tt file}
+Converts URL into a well-formed filename. The URL must use the {\tt file} 

 protocol.
 
 \wxheading{See also}
 
 protocol.
 
 \wxheading{See also}
 

-\helpref{wxFileSystem::FileNameToURL}{wxfilesystemfilenametourl},
+\helpref{wxFileSystem::FileNameToURL}{wxfilesystemfilenametourl}, 

 \helpref{wxFileName}{wxfilename}
 \helpref{wxFileName}{wxfilename}

+