aboutsummaryrefslogtreecommitdiff
path: root/src/doxy
diff options
context:
space:
mode:
authorMike Buland <eichlan@xagasoft.com>2009-08-09 05:30:34 +0000
committerMike Buland <eichlan@xagasoft.com>2009-08-09 05:30:34 +0000
commit4e86c50016ecfea40a72930cdd0460143f9edf4a (patch)
treee13c153b8042752a64134b3565e0e87a61d51398 /src/doxy
parent9e48c6f7d602364eb1c18de7e1e4c00e4852839c (diff)
downloadlibbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.gz
libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.bz2
libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.xz
libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.zip
Really, just a lot of documenting.
Diffstat (limited to '')
-rw-r--r--src/doxy/formatting.dox35
-rw-r--r--src/doxy/groups.dox10
-rw-r--r--src/doxy/main.dox1
-rw-r--r--src/doxy/streams.dox13
4 files changed, 47 insertions, 12 deletions
diff --git a/src/doxy/formatting.dox b/src/doxy/formatting.dox
new file mode 100644
index 0000000..7b440cb
--- /dev/null
+++ b/src/doxy/formatting.dox
@@ -0,0 +1,35 @@
1/*
2 * Copyright (C) 2007-2008 Xagasoft, All rights reserved.
3 *
4 * This file is part of the libbu++ library and is released under the
5 * terms of the license contained in the file LICENSE.
6 */
7
8/**
9 *@page howto_formatting Formatting data for streams and the console.
10 *
11 * Libbu++ provides a powerful and flexible interface for writing formatted
12 * data easily to any Stream. This is implemented as a seperate set of
13 * classes from the basic Stream system in order to simplify both systems and
14 * provide additional flexibility and organization.
15 *
16 *@section secBasics The Basics: Writing to the console (standard i/o)
17 * Libbu++ provides the global variable Bu::sio already instantiated and ready
18 * to be used to access the standard input and output via the Bu::Formatter
19 * class. If you are familiar with the STL cout then you're practically done.
20 * A quick example may be best.
21 *@code
22#include <bu/sio.h>
23using namespace Bu;
24
25int main()
26{
27 int i = 47;
28
29 sio << "Hello, world." << sio.nl
30 << "Here is a number: " << i << sio.nl;
31
32 return 0;
33}
34@endcode
35 */
diff --git a/src/doxy/groups.dox b/src/doxy/groups.dox
index 9b54950..285923c 100644
--- a/src/doxy/groups.dox
+++ b/src/doxy/groups.dox
@@ -6,26 +6,26 @@
6 */ 6 */
7 7
8/** 8/**
9 *@defgroup Threading 9 *@defgroup Threading Threading
10 * Threads are awesome. 10 * Threads are awesome.
11 */ 11 */
12 12
13/** 13/**
14 *@defgroup Serving 14 *@defgroup Serving Serving
15 * Serving data is pretty cool too. 15 * Serving data is pretty cool too.
16 */ 16 */
17 17
18/** 18/**
19 *@defgroup Containers 19 *@defgroup Containers Containers
20 * Containers for data. 20 * Containers for data.
21 */ 21 */
22 22
23/** 23/**
24 *@defgroup Taf 24 *@defgroup Taf Taf
25 * Taf is the best! 25 * Taf is the best!
26 */ 26 */
27 27
28/** 28/**
29 *@defgroup Streams 29 *@defgroup Streams Streams
30 * Streams are for data. 30 * Streams are for data.
31 */ 31 */
diff --git a/src/doxy/main.dox b/src/doxy/main.dox
index 6030f0c..5e822e1 100644
--- a/src/doxy/main.dox
+++ b/src/doxy/main.dox
@@ -18,6 +18,7 @@
18 * comprehensive guides and API reference, but doesn't yet. For now check out 18 * comprehensive guides and API reference, but doesn't yet. For now check out
19 * these sections: 19 * these sections:
20 * - @ref howto_streams 20 * - @ref howto_streams
21 * - @ref howto_formatting
21 * - @ref howto_archives 22 * - @ref howto_archives
22 * - @ref howto_threading 23 * - @ref howto_threading
23 * - @ref howto_servers 24 * - @ref howto_servers
diff --git a/src/doxy/streams.dox b/src/doxy/streams.dox
index 8217210..9655743 100644
--- a/src/doxy/streams.dox
+++ b/src/doxy/streams.dox
@@ -44,11 +44,10 @@
44 * data. 44 * data.
45 * 45 *
46 *@section difference How are libbu++ streams different form stl streams? 46 *@section difference How are libbu++ streams different form stl streams?
47 * While not globally true, many stl streams are designed for formatting the 47 * The most basic difference is that libbu++ streams are geared more towards a
48 * data that flows through the stream, that means that when you attempt to 48 * lower level feel, giving you easy and more direct access to many features,
49 * write a uint32_t into a standard stream it can be difficult to predict what 49 * while seperating all of the formatting code used for console I/O and number
50 * the result will be, will it be the binary representation or a textual 50 * to text conversion, etc, in a seperate place.
51 * conversion?
52 * 51 *
53 * Libbu++ streams are very direct about how the data is handled. All end-point 52 * Libbu++ streams are very direct about how the data is handled. All end-point
54 * streams will always handle the data that you provide or request without any 53 * streams will always handle the data that you provide or request without any
@@ -59,8 +58,8 @@
59 * easy as possible to write general code that was as easy as possible to 58 * easy as possible to write general code that was as easy as possible to
60 * extend, and as clear as possible. We have accomplished this by making 59 * extend, and as clear as possible. We have accomplished this by making
61 * streams simple, yet flexible, with a clear API and a flexible filter system 60 * streams simple, yet flexible, with a clear API and a flexible filter system
62 * that something geared towards more general formatting, conversion, and 61 * that something geared towards more general formatting, conversion can't
63 * operator-only access can't touch. 62 * touch.
64 * 63 *
65 *@section usage Using streams directly 64 *@section usage Using streams directly
66 * To create a stream depends on the type of stream that you're interested in, 65 * To create a stream depends on the type of stream that you're interested in,