From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Tue, 29 Jun 2004 07:53:03 +0000 (+0000)
Subject: documented return value of Find[Absolute]ValidPath() correctly
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/4d01e350fe2d8cb15c068d579c4022345f3ff0c0

documented return value of Find[Absolute]ValidPath() correctly


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

diff --git a/docs/latex/wx/pathlist.tex b/docs/latex/wx/pathlist.tex
index 0a2729f0e4..6f04950e11 100644
--- a/docs/latex/wx/pathlist.tex
+++ b/docs/latex/wx/pathlist.tex
@@ -24,12 +24,14 @@ from the path.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxPathList::wxPathList}
 
 \func{}{wxPathList}{\void}
 
 Constructor.
 
+
 \membersection{wxPathList::AddEnvList}
 
 \func{void}{AddEnvList}{\param{const wxString\& }{env\_variable}}
@@ -38,13 +40,15 @@ Finds the value of the given environment variable, and adds all paths
 to the path list. Useful for finding files in the PATH variable, for
 example.
 
+
 \membersection{wxPathList::Add}
 
 \func{void}{Add}{\param{const wxString\& }{path}}
 
 Adds the given directory to the path list, but does not
-check if the path was already on the list (use wxPathList::Member)
-for this).
+check if the path was already on the list (use 
+\helpref{wxPathList::Member()}{wxpathlistmember} for this).
+
 
 \membersection{wxPathList::EnsureFileAccessible}
 
@@ -54,24 +58,26 @@ Given a full filename (with path), ensures that files in the same path
 can be accessed using the pathlist. It does this by stripping the
 filename and adding the path to the list if not already there.
 
+
 \membersection{wxPathList::FindAbsoluteValidPath}
 
 \func{wxString}{FindAbsoluteValidPath}{\param{const wxString\& }{file}}
 
 Searches for a full path for an existing file by appending {\it file} to
-successive members of the path list.  If the file exists, a temporary
-pointer to the absolute path is returned.
+successive members of the path list.  If the file wasn't found, an empty
+string is returned.
+
 
 \membersection{wxPathList::FindValidPath}
 
 \func{wxString}{FindValidPath}{\param{const wxString\& }{file}}
 
 Searches for a full path for an existing file by appending {\it file} to
-successive members of the path list.  If the file exists, a temporary
-pointer to the full path is returned. This path may be relative to the current
-working directory.
+successive members of the path list.  If the file wasn't found, an empty string
+is returned. This path may be relative to the current working directory.
+
 
-\membersection{wxPathList::Member}
+\membersection{wxPathList::Member}\label{wxpathlistmember}
 
 \func{bool}{Member}{\param{const wxString\& }{file}}