// $Id$
//
// Copyright (C) 2007
// Fraunhofer Institute for Open Communication Systems (FOKUS)
//
// The contents of this file are subject to the Fraunhofer FOKUS Public License
// Version 1.0 (the "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at 
// http://senf.berlios.de/license.html
//
// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
// but modifies the Mozilla Public License Version 1.1.
// See the full license text for the amendments.
//
// Software distributed under the License is distributed on an "AS IS" basis, 
// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
// for the specific language governing rights and limitations under the License.
//
// The Original Code is Fraunhofer FOKUS code.
//
// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
//
// Contributor(s):
//   Stefan Bund <g0dil@berlios.de>


namespace senf {

/** \mainpage The SENF Utilities Library

    The Utilities Library is a collection of independent utilities.


    \section basic_helpers C++ Language helpers and library extensions

    <table class="listing">
    <tr><td>\ref membind</td><td>a simple <a
    href="http://www.boost.org/doc/libs/release/libs/bind/bind.html">Boost.Bind</a> extension</td></tr>

    <tr><td>\ref senfmpl</td><td>Some simple tools which help to solve common meta-programming
    tasks</td></tr>

    <tr><td>\ref senfpp</td><td>Extensions to the <a
    href="http://www.boost.org/doc/libs/release/libs/preprocessor/doc/index.html">Boost.Preprocessor</a>
    library</td></tr>

    <tr><td>\ref typetraits</td><td>Extensions to the <a
    href="http://www.boost.org/doc/libs/release/libs/type_traits/index.html">Boost.TypeTraits</a>
    library</td></tr>

    <tr><td>\ref boost_parameter</td><td>Utilities concerning the <a
    href="http://www.boost.org/doc/libs/release/libs/parameter/doc/html/index.html">Boost.Parameter</a>
    library</td></tr>

    <tr><td>\ref phoenix_helpers</td><td>Phoenix functors</td></tr>
    </table>


    \section basic_mixins Mixin classes

    <table class="listing">
    <tr><td>\ref intrusive_refcount</td><td>mixin to simplify writing classes for use with <a
    href="http://www.boost.org/doc/libs/release/libs/smart_ptr/intrusive_ptr.html">boost::intrusive_ptr</a></td></tr>

    <tr><td>\ref safe_bool</td><td>a mixin class to provide a really safe replacement for
    <tt>operator bool</tt>

    <tr><td>\ref singleton</td><td>mixin to make a class a singleton</td></tr>
    </table>


    \section memory_management Memory Management

    <table class="listing">
    <tr><td>\ref SENF_SCOPED_BUFFER</td><td>a portable way to efficiently allocate temporary
    buffers</td></tr>

    <tr><td>\ref pool_alloc_mixin</td><td>mixin to provide pool allocation to a class</td></tr>

    <tr><td>\ref contiguous_storage_iterator</td><td>traits class to check iterator type for raw
    pointer accessibility</td></tr>
    </table>


    \section typeinfo C++ Type interface

    <table class="listing">
    <tr><td>\ref prettyName()</td><td>an interface to the C++ demangler of g++ to get formated type
    names from typeinfo objects</td></tr>

    <tr><td>\ref TypeIdValue</td><td>class wrapping a typeid in a way that it can be used like any
    other value type, e.g. as the key in a map.</td></tr>
    </table>


    \section miscstuff Miscellaneous

    <table class="listing">
    <tr><td>\ref exception</td><td>standard exception for system errors (errno)</td></tr>

    <tr><td>\ref senf_statistics</td><td>statistics functionality</td></tr>

    <tr><td>\ref hexdump</td><td>a simple but usefull function to write binary data in in
    hexadecimal format.</td></tr>

    <tr><td>\ref IpChecksum</td><td>calculating the 16 bit checksum used in the IP
    specification</td></tr>

    <tr><td>\ref utils_tags</td><td>Miscellaneous type tags</td></tr>

    <tr><td>stringJoin()</td><td>Utility to join a string range into
    a single string (with separator)</td></tr>

    <tr><td>make_transform_range()</td><td>\c boost::make_transform_iterator() with support for
    ranges</td></tr>

    <tr><td>\ref backtraces</td><td>Utilities to parse and format backtrace information as provided
    by the GNU libc</td></tr>

    <tr><td>signalName()</td><td>convert signal number to string representation</td></tr>

    <tr><td>\ref senf_utils_format</td><td>\c iostream formating helpers for extended
    formats</td></tr>
    </table>


    \section testing Correctness and testing

    <table class="listing">
    <tr><td>\ref auto_unit_test.hh</td><td>Boost auto unit test compatibility across Boost versions
    1.33 and 1.34</td></tr>

    <tr><td>\ref SENF_ASSERT()</td><td>SENF specific assertion macro</td></tr>

    <tr><td>\ref unittest</td><td>Additional unit test extension for Boost.Test</td></tr>
    </table>
 */

}


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// mode: auto-fill
// End: