Add a bunch of comments about the different exceptions.

diff --git a/src/support/ExceptionMessage.h b/src/support/ExceptionMessage.h
index 347c7024f2bad15b4de0bcad67e0719654052672..fea2efa9fdc452eafba1862bfc20a1c868b23d8b 100644 (file)
--- a/src/support/ExceptionMessage.h
+++ b/src/support/ExceptionMessage.h
@@ -22,6 +22,22 @@
 namespace lyx {
 namespace support {
 
+/// LyX support three types of custom exceptions. In order of
+/// increasing seriousness, these are:
+///
+/// WarningException
+///   Intended for unexpected situations that we do not expect
+///   to compromise further operation. It has the effect of 
+///   aborting whatever operation in in process.
+///
+/// BufferException
+///   Intended for situations that indicate some problem with a
+///   Buffer or its related data structures. The Buffer will be
+///   closed, in emergency style.
+///
+/// ErrorException
+///   Intended for situations that indicate a global problem 
+///   with the program. It will lead to an emergency shutdown.
 
 enum ExceptionType {
        ErrorException,