Utils/Mainpage.dox

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 namespace senf {
  24
  25 /** \mainpage The SENF Utilities Library
  26
  27     The Utilities Library is a collection of independent utilities.
  28
  29
  30     \section basic_helpers C++ Language helpers and simple library extensions
  31
  32     <table class="listing">
  33     <tr><td>\ref membind</td><td>a simple <a
  34     href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a> extension</td></tr>
  35
  36     <tr><td>\ref senfmpl</td><td>Some simple tools which help to solve common meta-programming
  37     tasks</td></tr>
  38
  39     <tr><td>\ref senfpp</td><td>Extensions to the Boost.Preprocessor library</td></tr>
  40     </table>
  41
  42
  43     \section basic_mixins Basic mixin classes
  44
  45     <table class="listing">
  46     <tr><td>\ref intrusive_refcount</td><td>mixin to simplify writing classes for use with <a
  47     href="http://www.boost.org/libs/smart_ptr/intrusive_ptr.html">boost::intrusive_ptr</a></td></tr>
  48
  49     <tr><td>\ref safe_bool</td><td>a mixin class to provide a really safe replacement for
  50     <tt>operator bool</tt>
  51
  52     <tr><td>\ref singleton</td><td>mixin to make a class a singleton</td></tr>
  53     </table>
  54
  55
  56     \section memory_management Memory Management
  57
  58     <table class="listing">
  59     <tr><td>\ref SENF_SCOPED_BUFFER</td><td>a portable way to efficiently allocate temporary
  60     buffers</td></tr>
  61
  62     <tr><td>\ref pool_alloc_mixin</td><td>mixin to provide pool allocation to a class</td></tr>
  63
  64     <tr><td>\ref contiguous_storage_iterator</td><td>traits class to check iterator type for raw
  65     pointer accessibility</td></tr>
  66     </table>
  67
  68
  69     \section typeinfo C++ Type interface
  70
  71     <table class="listing">
  72     <tr><td>\ref prettyName()</td><td>an interface to the C++ demangler of g++ to get formated type
  73     names from typeinfo objects</td></tr>
  74
  75     <tr><td>\ref TypeIdValue</td><td>class wrapping a typeid in a way that it can be used like any
  76     other value type, e.g. as the key in a map.</td></tr>
  77     </table>
  78
  79
  80     \section miscstuff Miscellaneous
  81
  82     <table class="listing">
  83     <tr><td>\ref exception</td><td>standard exception for system errors (errno)</td></tr>
  84
  85     <tr><td>\ref hexdump</td><td>a simple but usefull function to write binary data in in
  86     hexadecimal format.</td></tr>
  87
  88     <tr><td>\ref IpChecksum</td><td>calculating the 16 bit checksum used in the IP
  89     specification</td></tr>
  90
  91     <tr><td>\ref utils_tags</td><td>Miscellaneous type tags</td></tr>
  92     </table>
  93
  94     \section compatibility Compatibility
  95
  96     <table class="listing">
  97     <tr><td>\ref auto_unit_test.hh</td><td>Boost auto unit test compatibility across Boost versions
  98     1.33 and 1.34</td></tr>
  99     </table>
 100  */
 101
 102 }
 103
 104 \f
 105 // Local Variables:
 106 // mode: c++
 107 // fill-column: 100
 108 // c-file-style: "senf"
 109 // indent-tabs-mode: nil
 110 // ispell-local-dictionary: "american"
 111 // mode: auto-fill
 112 // End: