X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FMainpage.dox;h=fe6dd746948be35794f24b299ab47c3d403d2e0f;hb=412024ed31a4ab4eaea7a4165a434f8efebee325;hp=b0670e651bb7adad5337238cb945e329d502e230;hpb=9cd0c7d8fc22ecf342c5d2a45980c245b827a67f;p=senf.git diff --git a/Utils/Mainpage.dox b/Utils/Mainpage.dox index b0670e6..fe6dd74 100644 --- a/Utils/Mainpage.dox +++ b/Utils/Mainpage.dox @@ -1,48 +1,130 @@ +// $Id$ +// +// Copyright (C) 2007 +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY +// Stefan Bund +// +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; either version 2 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program; if not, write to the +// Free Software Foundation, Inc., +// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + namespace senf { /** \mainpage The SENF Utilities Library - The Utilities Library is a collection of independent utilities. We have + The Utilities Library is a collection of independent utilities. + + + \section basic_helpers C++ Language helpers and library extensions -
+ + -
\ref logger
highly flexible logging infrastructure
+ -
SystemException
standard exception for system errors (errno)
+ -
\ref time
Very rudimentary microsecond time support
+ -
\ref process
Some simple process management and daemon helpers +
-
\ref membind
a simple Boost.Bind extension
+ +
\ref membinda simple Boost.Bind extension
\ref senfmplSome simple tools which help to solve common meta-programming + tasks
\ref senfppExtensions to the Boost.Preprocessor + library
\ref typetraitsExtensions to the Boost.TypeTraits + library
\ref boost_parameterUtilities concerning the Boost.Parameter + library
\ref phoenix_helpersPhoenix functors
-
intrusive_refcount
mixin to simplify writing classes for use with boost::intrusive_ptr
-
SafeBool
a mixin class to provide a really safe replacement for operator - bool
+ \section basic_mixins Mixin classes + + + + + +
\ref intrusive_refcountmixin to simplify writing classes for use with boost::intrusive_ptr
\ref safe_boola mixin class to provide a really safe replacement for + operator bool + +
\ref singletonmixin to make a class a singleton
-
pool_alloc_mixin
mixin to provide pool allocation to a class
+ + \section memory_management Memory Management + + + + + + + +
\ref SENF_SCOPED_BUFFERa portable way to efficiently allocate temporary + buffers
\ref pool_alloc_mixinmixin to provide pool allocation to a class
\ref contiguous_storage_iteratortraits class to check iterator type for raw + pointer accessibility
+ + + \section typeinfo C++ Type interface + + + + + +
\ref prettyName()an interface to the C++ demangler of g++ to get formated type + names from typeinfo objects
\ref TypeIdValueclass wrapping a typeid in a way that it can be used like any + other value type, e.g. as the key in a map.
-
\ref singleton
mixin to make a class a singleton
-
prettyName()
an interface to the C++ demangler of g++ to get formated type names - from typeinfo objects
+ \section miscstuff Miscellaneous -
\ref SENF_SCOPED_BUFFER
a portable way to efficiently allocate temporary - buffers
+ + -
\ref contiguous_storage_iterator
traits class to check iterator type for raw pointer - accessibility
+ -
\ref TypeIdValue
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.
+ + + + + -
\ref hexdump
-
a simple but usefull function to write binary data in in hexadecimal format.
+ + + + + +
\ref exceptionstandard exception for system errors (errno)
\ref hexdumpa simple but usefull function to write binary data in in + hexadecimal format.
\ref IpChecksumcalculating the 16 bit checksum used in the IP + specification
\ref utils_tagsMiscellaneous type tags
stringJoin()Utility to join a string range into + a single string (with separator)
make_transform_range()\c boost::make_transform_iterator() with support for + ranges
\ref backtracesUtilities to parse and format backtrace information as provided + by the GNU libc
signalName()convert signal number to string representation
+ + + \section testing Correctness and testing + + + + + - + +
\ref auto_unit_test.hhBoost auto unit test compatibility across Boost versions + 1.33 and 1.34
\ref SENF_ASSERT()SENF specific assertion macro
\ref unittestAdditional unit test extension for Boost.Test
*/ } @@ -54,6 +136,5 @@ namespace senf { // c-file-style: "senf" // indent-tabs-mode: nil // ispell-local-dictionary: "american" -// mode: flyspell // mode: auto-fill // End: