Restored the old Classes by Category page to live side-by-side with the full Classes...

[wxWidgets.git] / interface / debugrpt.h

diff --git a/interface/debugrpt.h b/interface/debugrpt.h
index bdb44b9922fcd22d8ebfae440db55d8219da013c..c79b13dcb8cba88c1b6b80df078c866aa846e7c5 100644 (file)
--- a/interface/debugrpt.h
+++ b/interface/debugrpt.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        debugrpt.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        debugrpt.h

-// Purpose:     documentation for wxDebugReportPreview class
+// Purpose:     interface of wxDebugReportPreview

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -43,10 +43,11 @@ public:
         report should be processed or @false if the user chose to cancel report
         generation or removed all files from it.
     */
         report should be processed or @false if the user chose to cancel report
         generation or removed all files from it.
     */

-    bool Show(wxDebugReport& dbgrpt);
+    bool Show(wxDebugReport& dbgrpt) const;

 };
 
 
 };
 
 

+

 /**
     @class wxDebugReportCompress
     @wxheader{debugrpt.h}
 /**
     @class wxDebugReportCompress
     @wxheader{debugrpt.h}


@@ -69,10 +70,11 @@ public:
     /**
         Returns the full path of the compressed file (empty if creation failed).
     */
     /**
         Returns the full path of the compressed file (empty if creation failed).
     */

-    const wxString GetCompressedFileName();
+    const wxString GetCompressedFileName() const;

 };
 
 
 };
 
 

+

 /**
     @class wxDebugReport
     @wxheader{debugrpt.h}
 /**
     @class wxDebugReport
     @wxheader{debugrpt.h}


@@ -80,7 +82,7 @@ public:
     wxDebugReport is used to generate a debug report, containing information about
     the program current state. It is usually used from
     wxApp::OnFatalException as shown in the
     wxDebugReport is used to generate a debug report, containing information about
     the program current state. It is usually used from
     wxApp::OnFatalException as shown in the

-    sample.
+    sample().

 
     A wxDebugReport object contains one or more files. A few of them can be created
     by the
 
     A wxDebugReport object contains one or more files. A few of them can be created
     by the


@@ -144,7 +146,6 @@ public:
 
     /**
         Adds the minidump file to the debug report.
 
     /**
         Adds the minidump file to the debug report.

-        

         Minidumps are only available under recent Win32 versions (@c dbghlp32.dll
         can be installed under older systems to make minidumps available).
     */
         Minidumps are only available under recent Win32 versions (@c dbghlp32.dll
         can be installed under older systems to make minidumps available).
     */


@@ -161,11 +162,10 @@ public:
     bool AddExceptionDump();
 
     /**
     bool AddExceptionDump();
 
     /**

-        Add another file to the report. If @e filename is an absolute path, it is
+        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
         copied to a file in the debug report directory with the same name. Otherwise
         the file should already exist in this directory

-        
-        @e description only exists to be displayed to the user in the report summary
+        @a description only exists to be displayed to the user in the report summary

         shown by wxDebugReportPreview.
     */
     void AddFile(const wxString& filename,
         shown by wxDebugReportPreview.
     */
     void AddFile(const wxString& filename,


@@ -173,9 +173,8 @@ public:
 
     /**
         This is a convenient wrapper around AddFile(). It
 
     /**
         This is a convenient wrapper around AddFile(). It

-        creates the file with the given @e name and writes @e text to it, then
-        adds the file to the report. The @e filename shouldn't contain the path.
-        
+        creates the file with the given @e name and writes @a text to it, then
+        adds the file to the report. The @a filename shouldn't contain the path.

         Returns @true if file could be added successfully, @false if an IO error
         occurred.
     */
         Returns @true if file could be added successfully, @false if an IO error
         occurred.
     */


@@ -187,7 +186,7 @@ public:
         context file created by AddContext(). By
         default, it does nothing.
     */
         context file created by AddContext(). By
         default, it does nothing.
     */

-    void DoAddCustomContext(wxXmlNode * nodeRoot);
+    void DoAddCustomContext(wxXmlNode* nodeRoot);

 
     /**
         This function may be overridden to modify the contents of the exception tag in
 
     /**
         This function may be overridden to modify the contents of the exception tag in


@@ -209,37 +208,36 @@ public:
 
     /**
         Returns the name of the temporary directory used for the files in this report.
 
     /**
         Returns the name of the temporary directory used for the files in this report.

-        

         This method should be used to construct the full name of the files which you
         wish to add to the report using AddFile().
     */
         This method should be used to construct the full name of the files which you
         wish to add to the report using AddFile().
     */

-    const wxString GetDirectory();
+    const wxString GetDirectory() const;

 
     /**
         Retrieves the name (relative to
         wxDebugReport::GetDirectory) and the description of the
 
     /**
         Retrieves the name (relative to
         wxDebugReport::GetDirectory) and the description of the

-        file with the given index. If @e n is greater than or equal to the number of
+        file with the given index. If @a n is greater than or equal to the number of

         filse, @false is returned.
     */
         filse, @false is returned.
     */

-    bool GetFile(size_t n, wxString* name, wxString* desc);
+    bool GetFile(size_t n, wxString* name, wxString* desc) const;

 
     /**
         Gets the current number files in this report.
     */
 
     /**
         Gets the current number files in this report.
     */

-    size_t GetFilesCount();
+    size_t GetFilesCount() const;

 
     /**
         Gets the name used as a base name for various files, by default
         wxApp::GetAppName is used.
     */
 
     /**
         Gets the name used as a base name for various files, by default
         wxApp::GetAppName is used.
     */

-    wxString GetReportName();
+    wxString GetReportName() const;

 
     /**
         Returns @true if the object was successfully initialized. If this method
         returns
         @false the report can't be used.
     */
 
     /**
         Returns @true if the object was successfully initialized. If this method
         returns
         @false the report can't be used.
     */

-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;

 
     /**
         Processes this report: the base class simply notifies the user that the
 
     /**
         Processes this report: the base class simply notifies the user that the


@@ -263,6 +261,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxDebugReportPreviewStd
     @wxheader{debugrpt.h}
 /**
     @class wxDebugReportPreviewStd
     @wxheader{debugrpt.h}


@@ -287,10 +286,11 @@ public:
         wxDebugReportPreview::Show for more
         information.
     */
         wxDebugReportPreview::Show for more
         information.
     */

-    bool Show(wxDebugReport& dbgrpt);
+    bool Show(wxDebugReport& dbgrpt) const;

 };
 
 
 };
 
 

+

 /**
     @class wxDebugReportUpload
     @wxheader{debugrpt.h}
 /**
     @class wxDebugReportUpload
     @wxheader{debugrpt.h}


@@ -307,11 +307,10 @@ class wxDebugReportUpload : public wxDebugReportCompress
 public:
     /**
         )
 public:
     /**
         )

-        

         This class will upload the compressed file created by its base class to an HTML
         This class will upload the compressed file created by its base class to an HTML

-        multipart/form-data form at the specified address. The @e url is the upload
-        page address, @e input is the name of the @c "type=file" control on
-        the form used for the file name and @e action is the value of the form
+        multipart/form-data form at the specified address. The @a url is the upload
+        page address, @a input is the name of the @c "type=file" control on
+        the form used for the file name and @a action is the value of the form

         action field. The report is uploaded using @c @e curl program which
         should be available, the @e curl parameter may be used to specify the full
         path to it.
         action field. The report is uploaded using @c @e curl program which
         should be available, the @e curl parameter may be used to specify the full
         path to it.


@@ -321,7 +320,6 @@ public:
 
     /**
         )
 
     /**
         )

-        

         This function may be overridden in a derived class to show the output from
         curl: this may be an HTML page or anything else that the server returned.
         Value returned by this function becomes the return value of
         This function may be overridden in a derived class to show the output from
         curl: this may be an HTML page or anything else that the server returned.
         Value returned by this function becomes the return value of


@@ -329,3 +327,4 @@ public:
     */
     bool OnServerReply();
 };
     */
     bool OnServerReply();
 };

+