Yet another deprecation fix (this is the last one I am aware of)

[lyx.git] / src / support / ExceptionMessage.h

diff --git a/src/support/ExceptionMessage.h b/src/support/ExceptionMessage.h
index 347c7024f2bad15b4de0bcad67e0719654052672..0bf59e58a232d9ab35548fe2a503f318a48b3ab9 100644 (file)
--- a/src/support/ExceptionMessage.h
+++ b/src/support/ExceptionMessage.h
@@ -8,9 +8,6 @@
  *
  * Full author contact details are available in file CREDITS.
  *
- * A store of the paths to the various different directoies used
- * by LyX. These paths differ markedly from one OS to another,
- * following the local Windows, MacOS X or Posix conventions.
  */
 #ifndef LYX_MESSAGE_H
 #define LYX_MESSAGE_H
@@ -22,6 +19,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,