X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FMainpage.dox;h=db219ffd6d16dfac0b6568b97798bd56e9eeb6ed;hb=28275a1a9075ae42dc29aaadc5bc78e6fa204e26;hp=7472bda6a79aff6fabb3bc6d0004e53b443d54d9;hpb=b52002fa2001e6472d6aa3dde263b85f654c6e8e;p=senf.git diff --git a/Utils/Mainpage.dox b/Utils/Mainpage.dox index 7472bda..db219ff 100644 --- a/Utils/Mainpage.dox +++ b/Utils/Mainpage.dox @@ -2,46 +2,77 @@ 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. -
-
SystemException
standard exception for system errors (errno)
+ \section basic_helpers C++ Language helpers and simple library extensions -
\ref process
Some simple process management and daemon helpers + + -
\ref membind
a simple Boost.Bind extension
+ -
intrusive_refcount
mixin to simplify writing classes for use with boost::intrusive_ptr
+ +
\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
-
SafeBool
a mixin class to provide a really safe replacement for operator - bool
+ + \section basic_mixins Basic 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 -
pool_alloc_mixin
mixin to provide pool allocation to a class
+
\ref singletonmixin to make a class a singleton
-
\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 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
-
\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
+ \section typeinfo C++ Type interface -
\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 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 hexdump
a simple but usefull function to write binary data in in hexadecimal - format.
-
\ref senfmpl
Some simple tools which help to solve common meta-programming - tasks
+ \section miscstuff Miscellaneous + + + + + + + +
\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
+ + \section compatibility Compatibility -
+ + +
\ref auto_unit_test.hhBoost auto unit test compatibility across Boost versions + 1.33 and 1.34
*/ } @@ -53,6 +84,5 @@ namespace senf { // c-file-style: "senf" // indent-tabs-mode: nil // ispell-local-dictionary: "american" -// mode: flyspell // mode: auto-fill // End: