fix typo

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

diff --git a/docs/latex/wx/debugrpt.tex b/docs/latex/wx/debugrpt.tex
index b5d394b7c21eff012dfc84aebb78bdee12653583..c465dfb1df66ba52a50fd9406f8fcf3f7941ef5f 100644 (file)
--- a/docs/latex/wx/debugrpt.tex
+++ b/docs/latex/wx/debugrpt.tex
@@ -142,25 +142,31 @@ The same as \helpref{AddDump(Context\_Exception)}{wxdebugreportadddump}.
 
 \membersection{wxDebugReport::AddFile}\label{wxdebugreportaddfile}
 
 
 \membersection{wxDebugReport::AddFile}\label{wxdebugreportaddfile}
 

-\func{void}{AddFile}{\param{const wxString\& }{name}, \param{const wxString\& }{description}}
+\func{void}{AddFile}{\param{const wxString\& }{filename}, \param{const wxString\& }{description}}

 
 

-Add another file to the report: the file must already exist on disk. Its name
-is relative to \helpref{GetDirectory()}{wxdebugreportgetdirectory}.
+Add another file to the report. If \arg{filename} is an absolute path, it is
+copied to a file in the debug report directory with the same name. Otherwise
+the file should already exist in this directory

 
 

-\arg{description} only exists to be shown to the user in the report summary
+\arg{description} only exists to be displayed to the user in the report summary

 shown by \helpref{wxDebugReportPreview}{wxdebugreportpreview}.
 
 shown by \helpref{wxDebugReportPreview}{wxdebugreportpreview}.
 

+\wxheading{See also }
+
+\helpref{GetDirectory()}{wxdebugreportgetdirectory},\\
+\helpref{AddText()}{wxdebugreportaddtext}
+

 
 \membersection{wxDebugReport::AddText}\label{wxdebugreportaddtext}
 
 
 \membersection{wxDebugReport::AddText}\label{wxdebugreportaddtext}
 

-\func{bool}{AddText}{\param{const wxString\& }{name}, \param{const wxString\& }{text}, \param{const wxString\& }{description}}
+\func{bool}{AddText}{\param{const wxString\& }{filename}, \param{const wxString\& }{text}, \param{const wxString\& }{description}}

 
 This is a convenient wrapper around \helpref{AddFile}{wxdebugreportaddfile}. It
 creates the file with the given \arg{name} and writes \arg{text} to it, then
 
 This is a convenient wrapper around \helpref{AddFile}{wxdebugreportaddfile}. It
 creates the file with the given \arg{name} and writes \arg{text} to it, then

-adds the file to the report.
+adds the file to the report. The \arg{filename} shouldn't contain the path.

 
 Returns \true if file could be added successfully, \false if an IO error
 
 Returns \true if file could be added successfully, \false if an IO error

-occured.
+occurred.

 
 
 \membersection{wxDebugReport::DoAddCustomContext}\label{wxdebugreportdoaddcustomcontext}
 
 
 \membersection{wxDebugReport::DoAddCustomContext}\label{wxdebugreportdoaddcustomcontext}