diff options
Diffstat (limited to 'src/doxy/main.dox')
-rw-r--r-- | src/doxy/main.dox | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/doxy/main.dox b/src/doxy/main.dox new file mode 100644 index 0000000..7268890 --- /dev/null +++ b/src/doxy/main.dox | |||
@@ -0,0 +1,21 @@ | |||
1 | /** | ||
2 | *@mainpage libbu++ utility library | ||
3 | * | ||
4 | *@section secIntro Introduction | ||
5 | * | ||
6 | * Libbu++ is a C++ library of general utility classes and functions. They | ||
7 | * cover a wide range of topics from streams and sockets to data structures to | ||
8 | * data serialization and xml handling to threading. | ||
9 | * | ||
10 | * This documentation is expanding all the time, and should contain | ||
11 | * comprehensive guides and API reference, but doesn't yet. For now check out | ||
12 | * these sections: | ||
13 | * - @ref howto_streams | ||
14 | * - @ref howto_archives | ||
15 | * - @ref howto_threading | ||
16 | * - @ref howto_servers | ||
17 | */ | ||
18 | |||
19 | /** | ||
20 | *@namespace Bu The core libbu++ namespace, to ensure things don't get muddied. | ||
21 | */ | ||