COIN-OR::LEMON - Graph Library

Changeset 2175:0975cad06c2b in lemon-0.x


Ignore:
Timestamp:
08/10/06 15:54:01 (13 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2890
Message:

Doc improvements

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/error.h

    r2153 r2175  
    583583///
    584584/// The assertions are disabled in the default behaviour. You can
    585 /// enable the assertions with the LEMON_ENABLE_ASSERTS macro what
     585/// enable the assertions with the
     586/// \code
     587/// #define LEMON_ENABLE_ASSERTS
     588/// \endcode
     589/// Then an assert
    586590/// provides a log on the standard error about the assertion and aborts
    587 /// the program.  If the LEMON_ASSERT_DO_ABORT macro is setted to false
    588 /// then the just the log message can be seen on the standard error but
    589 /// the program is not stopped. With the LEMON_ASSERT_FAILURE and
    590 /// LEMON_ASSERT_EXCEPTION macros you can set other behaviour to the
    591 /// assertions. The LEMON_ASSERT_FAILURE will always throw an \c
    592 /// AssertionFailedError exception with the \c msg error message. The
    593 /// \c LEMON_ASSERT_EXCEPTION can throw a user defined exception.
     591/// the program if LEMON_ASSERT_DO_ABORT is also defined (otherwise the
     592/// program keeps on running).
     593/// By defining LEMON_ASSERT_FAILURE or
     594/// LEMON_ASSERT_EXCEPTION, you can set other behaviour to the
     595/// assertions. In case LEMON_ASSERT_FAILURE is given, LEMON_ASSERT
     596/// will always throw an \c AssertionFailedError exception with
     597/// the \c msg error message. By using
     598/// LEMON_ASSERT_EXCEPTION, one can define an arbitrary exception to be thrown.
    594599///
    595600/// The LEMON_ASSERT macro should be called with the \c exp parameter
     
    600605/// \ref "Exception::what" what() function is called to retrieve and
    601606/// display the error message.
    602 ///
    603607///
    604608/// \todo We should provide some way to reset to the default behaviour,
Note: See TracChangeset for help on using the changeset viewer.