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