X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FMainpage.dox;h=db219ffd6d16dfac0b6568b97798bd56e9eeb6ed;hb=28275a1a9075ae42dc29aaadc5bc78e6fa204e26;hp=e5b53ddb44a28585a736b7ec18e93ad3824dbb05;hpb=36dec8105bf99dec12ffa07149f72923a71001e5;p=senf.git
diff --git a/Utils/Mainpage.dox b/Utils/Mainpage.dox
index e5b53dd..db219ff 100644
--- a/Utils/Mainpage.dox
+++ b/Utils/Mainpage.dox
@@ -2,39 +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.
- - \ref logger
- highly flexible logging
- infrastructure
- - SystemException
- standard exception for system errors
- (errno)
+ \section basic_helpers C++ Language helpers and simple library extensions
- - \ref time
- Very rudimentary microsecond time
- support
+
+ \ref membind | a simple Boost.Bind extension |
- - \ref process
- Some simple process management and daemon
- helpers
+
\ref senfmpl | Some simple tools which help to solve common meta-programming
+ tasks |
- - \ref membind
- a simple Boost.Bind
- extension
+ \ref senfpp | Extensions to the Boost.Preprocessor library |
+
- - 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 Basic mixin classes
+
+
+ \ref intrusive_refcount | mixin to simplify writing classes for use with boost::intrusive_ptr |
- - prettyName()
- an interface to the C++ demangler of g++
- to get formated type names from typeinfo objects
+ \ref safe_bool | a mixin class to provide a really safe replacement for
+ operator bool
+
+ |
\ref singleton | mixin to make a class a singleton |
+
+
- - \ref SENF_SCOPED_BUFFER
- a portable way to efficiently allocate temporary buffers
+ \section memory_management Memory Management
-
+
+ \ref SENF_SCOPED_BUFFER | a portable way to efficiently allocate temporary
+ buffers |
+
+ \ref pool_alloc_mixin | mixin to provide pool allocation to a class |
+
+ \ref contiguous_storage_iterator | traits 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 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. |
+
+
+
+ \section miscstuff Miscellaneous
+
+
+ \ref exception | standard exception for system errors (errno) |
+
+ \ref hexdump | a simple but usefull function to write binary data in in
+ hexadecimal format. |
+
+ \ref IpChecksum | calculating the 16 bit checksum used in the IP
+ specification |
+
+
+ \section compatibility Compatibility
+
+
+ \ref auto_unit_test.hh | Boost auto unit test compatibility across Boost versions
+ 1.33 and 1.34 |
+
*/
}
@@ -46,6 +84,5 @@ namespace senf {
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
-// mode: flyspell
// mode: auto-fill
// End: