From 4e86c50016ecfea40a72930cdd0460143f9edf4a Mon Sep 17 00:00:00 2001 From: Mike Buland Date: Sun, 9 Aug 2009 05:30:34 +0000 Subject: Really, just a lot of documenting. --- src/doxy/formatting.dox | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 src/doxy/formatting.dox (limited to 'src/doxy/formatting.dox') 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 @@ +/* + * Copyright (C) 2007-2008 Xagasoft, All rights reserved. + * + * This file is part of the libbu++ library and is released under the + * terms of the license contained in the file LICENSE. + */ + +/** + *@page howto_formatting Formatting data for streams and the console. + * + * Libbu++ provides a powerful and flexible interface for writing formatted + * data easily to any Stream. This is implemented as a seperate set of + * classes from the basic Stream system in order to simplify both systems and + * provide additional flexibility and organization. + * + *@section secBasics The Basics: Writing to the console (standard i/o) + * Libbu++ provides the global variable Bu::sio already instantiated and ready + * to be used to access the standard input and output via the Bu::Formatter + * class. If you are familiar with the STL cout then you're practically done. + * A quick example may be best. + *@code +#include +using namespace Bu; + +int main() +{ + int i = 47; + + sio << "Hello, world." << sio.nl + << "Here is a number: " << i << sio.nl; + + return 0; +} +@endcode + */ -- cgit v1.2.3