A little cleanup for this demo

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

diff --git a/docs/latex/wx/tempfile.tex b/docs/latex/wx/tempfile.tex
index 01a31ffdb293f79d562bd2826a79ef548d3bff69..1bb2f1bf9deddc3143378a779a213e2732ea2218 100644 (file)
--- a/docs/latex/wx/tempfile.tex
+++ b/docs/latex/wx/tempfile.tex
@@ -65,25 +65,31 @@ Associates wxTempFile with the file to be replaced and opens it. You should use
 
 \func{bool}{Open}{\param{const wxString\& }{strName}}
 
-Open the temporary file (strName is the name of file to be replaced), returns
-TRUE on success, FALSE if an error occurred.
+Open the temporary file, returns {\tt TRUE} on success, {\tt FALSE} if an error
+occurred.
+
+{\it strName} is the name of file to be replaced. The temporary file is always
+created in the directory where {\it strName} is. In particular, if 
+{\it strName} doesn't include the path, it is created in the current directory
+and the program should have write access to it for the function to succeed.
 
 \membersection{wxTempFile::IsOpened}\label{wxtempfileisopened}
+
 \constfunc{bool}{IsOpened}{\void}
 
-Returns TRUE if the file was successfully opened.
+Returns {\tt TRUE} if the file was successfully opened.
 
 \membersection{wxTempFile::Write}\label{wxtempfilewrite}
 
 \func{bool}{Write}{\param{const void }{*p}, \param{size\_t }{n}}
 
-Write to the file, return TRUE on success, FALSE on failure.
+Write to the file, return {\tt TRUE} on success, {\tt FALSE} on failure.
 
 \membersection{wxTempFile::Write}\label{wxtempfilewrites}
 
 \func{bool}{Write}{\param{const wxString\& }{str}, \param{wxMBConv&}{ conv = wxConvLibc}}
 
-Write to the file, return TRUE on success, FALSE on failure.
+Write to the file, return {\tt TRUE} on success, {\tt FALSE} on failure.
 
 The second argument is only meaningful in Unicode build of wxWindows when
 {\it conv} is used to convert {\it str} to multibyte representation.
@@ -93,7 +99,7 @@ The second argument is only meaningful in Unicode build of wxWindows when
 \func{bool}{Commit}{\void}
 
 Validate changes: deletes the old file of name m\_strName and renames the new
-file to the old name. Returns TRUE if both actions succeeded. If FALSE is
+file to the old name. Returns {\tt TRUE} if both actions succeeded. If {\tt FALSE} is
 returned it may unfortunately mean two quite different things: either that
 either the old file couldn't be deleted or that the new file couldn't be renamed
 to the old name.