libfsafe/mainpage.hxx

   1 /**
   2  * @mainpage
   3  *
   4  * @section Overview
   5  *
   6  * Usually, all you need is macros. The following ones
   7  * exist:
   8  *
   9  * @li @ref ASSERT
  10  * @li @ref ASSERT_PRE
  11  * @li @ref ASSERT_POST
  12  * @li @ref CHECKPOINT
  13  *
  14  *
  15  * @section Usage Example
  16  *
  17  * The unit tests serve as compilable and runnable
  18  * documentation and examples.
  19  *
  20  * Heres the one that is intended as a short tutorial:
  21  *
  22  * @c tests/Example.cxx
  23  * @include Example.cxx
  24  */