aboutsummaryrefslogtreecommitdiff
path: root/src/doxy/streams.dox
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/streams.dox
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/streams.dox13
1 files changed, 6 insertions, 7 deletions
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,