Utils/Mainpage.dox

   1 namespace senf {
   2
   3 /** \mainpage The SENF Utilities Library
   4
   5     The Utilities Library is a collection of independent utilities.
   6
   7
   8     \section basic_helpers C++ Language helpers and simple library extensions
   9
  10     <table class="listing">
  11     <tr><td>\ref membind</td><td>a simple <a
  12     href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a> extension</td></tr>
  13
  14     <tr><td>\ref senfmpl</td><td>Some simple tools which help to solve common meta-programming
  15     tasks</td></tr>
  16
  17     <tr><td>\ref senfpp</td><td>Extensions to the Boost.Preprocessor library</td></tr>
  18     </table>
  19
  20
  21     \section basic_mixins Basic mixin classes
  22
  23     <table class="listing">
  24     <tr><td>\ref intrusive_refcount</td><td>mixin to simplify writing classes for use with <a
  25     href="http://www.boost.org/libs/smart_ptr/intrusive_ptr.html">boost::intrusive_ptr</a></td></tr>
  26
  27     <tr><td>\ref safe_bool</td><td>a mixin class to provide a really safe replacement for
  28     <tt>operator bool</tt>
  29
  30     <tr><td>\ref singleton</td><td>mixin to make a class a singleton</td></tr>
  31     </table>
  32
  33
  34     \section memory_management Memory Management
  35
  36     <table class="listing">
  37     <tr><td>\ref SENF_SCOPED_BUFFER</td><td>a portable way to efficiently allocate temporary
  38     buffers</td></tr>
  39
  40     <tr><td>\ref pool_alloc_mixin</td><td>mixin to provide pool allocation to a class</td></tr>
  41
  42     <tr><td>\ref contiguous_storage_iterator</td><td>traits class to check iterator type for raw
  43     pointer accessibility</td></tr>
  44     </table>
  45
  46
  47     \section typeinfo C++ Type interface
  48
  49     <table class="listing">
  50     <tr><td>\ref prettyName()</td><td>an interface to the C++ demangler of g++ to get formated type
  51     names from typeinfo objects</td></tr>
  52
  53     <tr><td>\ref TypeIdValue</td><td>class wrapping a typeid in a way that it can be used like any
  54     other value type, e.g. as the key in a map.</td></tr>
  55     </table>
  56
  57
  58     \section miscstuff Miscellaneous
  59
  60     <table class="listing">
  61     <tr><td>\ref SystemException</td><td>standard exception for system errors (errno)</td></tr>
  62
  63     <tr><td>\ref process</td><td>Some simple process management and daemon helpers</td></tr>
  64
  65     <tr><td>\ref hexdump</td><td>a simple but usefull function to write binary data in in
  66     hexadecimal format.</td></tr>
  67
  68     <tr><td>\ref IpChecksum</td><td>calculating the 16 bit checksum used in the IP
  69     specification</td></tr>
  70     </table>
  71
  72     \section compatibility Compatibility
  73
  74     <table class="listing">
  75     <tr><td>\ref auto_unit_test.hh</td><td>Boost auto unit test compatibility across Boost versions
  76     1.33 and 1.34</td></tr>
  77     </table>
  78  */
  79
  80 }
  81
  82 \f
  83 // Local Variables:
  84 // mode: c++
  85 // fill-column: 100
  86 // c-file-style: "senf"
  87 // indent-tabs-mode: nil
  88 // ispell-local-dictionary: "american"
  89 // mode: auto-fill
  90 // End: