Some small documentation fixes
[senf.git] / Utils / Mainpage.dox
1 namespace senf {
2
3 /** \mainpage The SENF Utilities Library
4
5     The Utilities Library is a collection of independent utilities. We have 
6
7     <dl>
8
9     <dt>\ref logger</dt><dd>highly flexible logging infrastructure</dd>
10
11     <dt>SystemException</dt><dd>standard exception for system errors (errno)</dd>
12
13     <dt>\ref process</dt><dd>Some simple process management and daemon helpers<?dd>
14
15     <dt>\ref membind</dt><dd>a simple <a
16     href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a> extension</dd>
17
18     <dt>intrusive_refcount</dt><dd>mixin to simplify writing classes for use with <a
19     href="http://www.boost.org/libs/smart_ptr/intrusive_ptr.html">boost::intrusive_ptr</a></dd>
20
21     <dt>SafeBool</dt><dd>a mixin class to provide a really safe replacement for <tt>operator
22     bool</tt></dd>
23     
24     <dt>pool_alloc_mixin</dt><dd>mixin to provide pool allocation to a class</dd>
25     
26     <dt>\ref singleton</dt><dd>mixin to make a class a singleton</dd>
27
28     <dt>prettyName()</dt><dd>an interface to the C++ demangler of g++ to get formated type names
29     from typeinfo objects</dd>
30
31     <dt>\ref SENF_SCOPED_BUFFER</dt><dd>a portable way to efficiently allocate temporary
32     buffers</dd>
33
34     <dt>\ref contiguous_storage_iterator</dt><dd>traits class to check iterator type for raw pointer
35     accessibility</dd>
36
37     <dt>\ref TypeIdValue</dt><dd>class wrapping a typeid in a way that it can be used like any other
38     value type, e.g. as the key in a map.</dd>
39     
40     <dt>\ref hexdump<dt><dd>a simple but usefull function to write binary data in in hexadecimal
41     format.</dd>
42
43     <dt>\ref senfmpl</dt><dd>Some simple tools which help to solve common meta-programming
44     tasks</dd>
45
46     </dl>
47  */
48
49 }
50
51 \f
52 // Local Variables:
53 // mode: c++
54 // fill-column: 100
55 // c-file-style: "senf"
56 // indent-tabs-mode: nil
57 // ispell-local-dictionary: "american"
58 // mode: flyspell
59 // mode: auto-fill
60 // End: