Utils/Mainpage.dox

   1 namespace senf {
   2
   3 /** \mainpage The SENF Utilities Library
   4
   5     The Utilities Library is a collection of independent utilities. We have
   6
   7     <dl>
   8
   9     <dt>\ref logger</dt><dd>highly flexible logging infrastructure</dd>
  10
  11     <dt>SystemException</dt><dd>standard exception for system errors (errno)</dd>
  12
  13     <dt>\ref time</dt><dd>Very rudimentary microsecond time support</dd>
  14
  15     <dt>\ref process</dt><dd>Some simple process management and daemon helpers<?dd>
  16
  17     <dt>\ref membind</dt><dd>a simple <a
  18     href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a> extension</dd>
  19
  20     <dt>intrusive_refcount</dt><dd>mixin to simplify writing classes for use with <a
  21     href="http://www.boost.org/libs/smart_ptr/intrusive_ptr.html">boost::intrusive_ptr</a></dd>
  22
  23     <dt>SafeBool</dt><dd>a mixin class to provide a really safe replacement for <tt>operator
  24     bool</tt></dd>
  25
  26     <dt>pool_alloc_mixin</dt><dd>mixin to provide pool allocation to a class</dd>
  27
  28     <dt>\ref singleton</dt><dd>mixin to make a class a singleton</dd>
  29
  30     <dt>prettyName()</dt><dd>an interface to the C++ demangler of g++ to get formated type names
  31     from typeinfo objects</dd>
  32
  33     <dt>\ref SENF_SCOPED_BUFFER</dt><dd>a portable way to efficiently allocate temporary
  34     buffers</dd>
  35
  36     <dt>\ref contiguous_storage_iterator</dt><dd>traits class to check iterator type for raw pointer
  37     accessibility</dd>
  38
  39     <dt>\ref TypeIdValue</dt><dd>class wrapping a typeid in a way that it can be used like any other
  40     value type, e.g. as the key in a map.</dd>
  41
  42     <dt>\ref hexdump<dt>
  43         <dd>a simple but usefull function to write binary data in in hexadecimal format.</dd>
  44
  45     </dl>
  46  */
  47
  48 }
  49
  50 \f
  51 // Local Variables:
  52 // mode: c++
  53 // fill-column: 100
  54 // c-file-style: "senf"
  55 // indent-tabs-mode: nil
  56 // ispell-local-dictionary: "american"
  57 // mode: flyspell
  58 // mode: auto-fill
  59 // End: