Doc improvements
authoralpar
Thu, 10 Aug 2006 13:54:01 +0000
changeset 21750975cad06c2b
parent 2174 f9e43b5cc617
child 2176 0f647e65ecad
Doc improvements
lemon/error.h
     1.1 --- a/lemon/error.h	Thu Aug 10 13:52:56 2006 +0000
     1.2 +++ b/lemon/error.h	Thu Aug 10 13:54:01 2006 +0000
     1.3 @@ -582,15 +582,20 @@
     1.4  /// Macro for assertions with customizable message.
     1.5  ///
     1.6  /// The assertions are disabled in the default behaviour. You can
     1.7 -/// enable the assertions with the LEMON_ENABLE_ASSERTS macro what
     1.8 +/// enable the assertions with the
     1.9 +/// \code
    1.10 +/// #define LEMON_ENABLE_ASSERTS
    1.11 +/// \endcode
    1.12 +/// Then an assert
    1.13  /// provides a log on the standard error about the assertion and aborts
    1.14 -/// the program.  If the LEMON_ASSERT_DO_ABORT macro is setted to false
    1.15 -/// then the just the log message can be seen on the standard error but
    1.16 -/// the program is not stopped. With the LEMON_ASSERT_FAILURE and
    1.17 -/// LEMON_ASSERT_EXCEPTION macros you can set other behaviour to the
    1.18 -/// assertions. The LEMON_ASSERT_FAILURE will always throw an \c
    1.19 -/// AssertionFailedError exception with the \c msg error message. The
    1.20 -/// \c LEMON_ASSERT_EXCEPTION can throw a user defined exception.
    1.21 +/// the program if LEMON_ASSERT_DO_ABORT is also defined (otherwise the
    1.22 +/// program keeps on running).
    1.23 +/// By defining LEMON_ASSERT_FAILURE or
    1.24 +/// LEMON_ASSERT_EXCEPTION, you can set other behaviour to the
    1.25 +/// assertions. In case LEMON_ASSERT_FAILURE is given, LEMON_ASSERT
    1.26 +/// will always throw an \c AssertionFailedError exception with
    1.27 +/// the \c msg error message. By using
    1.28 +/// LEMON_ASSERT_EXCEPTION, one can define an arbitrary exception to be thrown.
    1.29  ///
    1.30  /// The LEMON_ASSERT macro should be called with the \c exp parameter
    1.31  /// which should be an expression convertible to bool. If the given
    1.32 @@ -600,7 +605,6 @@
    1.33  /// \ref "Exception::what" what() function is called to retrieve and
    1.34  /// display the error message.
    1.35  ///
    1.36 -///
    1.37  /// \todo We should provide some way to reset to the default behaviour,
    1.38  /// shouldn't we?
    1.39  ///