summaryrefslogtreecommitdiff
path: root/src/doxy/main.dox
diff options
context:
space:
mode:
authorMike Buland <eichlan@xagasoft.com>2007-10-03 09:13:28 +0000
committerMike Buland <eichlan@xagasoft.com>2007-10-03 09:13:28 +0000
commitb3eef5b0b82c20a9f11868ba376f6bb2d94faae4 (patch)
tree7c5f4243d3a528f86daad826ed886dea6b816871 /src/doxy/main.dox
parent850ebb96df909a4113fdf9c5bf82cf0f598901ca (diff)
downloadlibbu++-b3eef5b0b82c20a9f11868ba376f6bb2d94faae4.tar.gz
libbu++-b3eef5b0b82c20a9f11868ba376f6bb2d94faae4.tar.bz2
libbu++-b3eef5b0b82c20a9f11868ba376f6bb2d94faae4.tar.xz
libbu++-b3eef5b0b82c20a9f11868ba376f6bb2d94faae4.zip
Nothing about function. I added a bunch of docs and re-arranged a bunch of
the existing docs. Taking advantage of some of the cooler extra features of doxygen I've started writing extra how-to pages covering working with sections of the library. Also, I started grouping the classes by function so they show up on the Modules page together, very cute.
Diffstat (limited to 'src/doxy/main.dox')
-rw-r--r--src/doxy/main.dox21
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 */