// Name: debugrpt.h
// Purpose: interface of wxDebugReport*
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
By default, a unique name constructed from wxApp::GetAppName(), the
current process id and the current date and time is used.
- @param dir
+ @param name
The base name (i.e. without extension) of the file.
@since 2.9.1
/**
Add another file to the report. If @a 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
- @a description only exists to be displayed to the user in the report
- summary shown by wxDebugReportPreview.
+ Otherwise the file will be searched in the temporary directory returned
+ by GetDirectory().
+
+ The argument @a description only exists to be displayed to the user in
+ the report summary shown by wxDebugReportPreview.
@see GetDirectory(), AddText()
*/
/**
Retrieves the name (relative to GetDirectory()) and the description of
the file with the given index. If @a n is greater than or equal to the
- number of filse, @false is returned.
+ number of files, then @false is returned.
*/
bool GetFile(size_t n, wxString* name, wxString* desc) const;