aboutsummaryrefslogtreecommitdiff
path: root/src/doxy/formatting.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/doxy/formatting.dox')
-rw-r--r--src/doxy/formatting.dox35
1 files changed, 35 insertions, 0 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 */