Add a bunch of comments about the different exceptions.

This commit is contained in:
Richard Heck 2013-04-07 18:11:27 -04:00
parent 6c983d6cd1
commit 88d9f08806

View File

@ -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,