[lmi-commits] [5848] Improve documentation

[Greg Chicares]

Revision: 5848
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5848
Author:   chicares
Date:     2013-12-06 18:11:12 +0000 (Fri, 06 Dec 2013)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/main_wx.cpp

Modified: lmi/trunk/main_wx.cpp
===================================================================
--- lmi/trunk/main_wx.cpp       2013-11-22 20:03:26 UTC (rev 5847)
+++ lmi/trunk/main_wx.cpp       2013-12-06 18:11:12 UTC (rev 5848)
@@ -574,10 +574,11 @@
 
 /// Rethrow an exception caught by wx into a local catch clause.
 ///
+/// Report the exception, then return 'true' to continue processing.
+///
 /// This virtual function exists only to be overridden. Calling the
-/// base-class implementation would be pointless.
-///
-/// For MinGW gcc-3.4.4 and earlier
+/// base-class implementation would normally be pointless. However,
+/// for MinGW gcc-3.4.4 and earlier
 ///   http://article.gmane.org/gmane.comp.gnu.mingw.user/18594
 ///     [2006-01-10T22:00:24Z from Danny Smith]
 /// it is crucial that the exception be rethrown from the same shared
@@ -963,6 +964,12 @@
     test_arbitrary_exception();
 }
 
+/// Test catastrophic-error report.
+///
+/// This error occurs only when normal error reporting is impossible;
+/// it is internal to 'alert.cpp', so no corresponding application-
+/// level UponTestAppCatastropheReport() can be written.
+
 void Skeleton::UponTestLibCatastropheReport(wxCommandEvent&)
 {
     test_catastrophe_report();