Put these in a Streams doxygen group. We should think of some more groups,

2008-03-03  Murray Cumming  <murrayc@murrayc.com>

* gio/src/bufferedinputstream.hg:
* gio/src/bufferedoutputstream.hg:
* gio/src/datainputstream.hg:
* gio/src/dataoutputstream.hg:
* gio/src/fileinputstream.hg:
* gio/src/fileoutputstream.hg:
* gio/src/filterinputstream.hg:
* gio/src/filteroutputstream.hg:
* gio/src/inputstream.hg:
* gio/src/memoryinputstream.hg:
* gio/src/mount.hg:
* gio/src/outputstream.hg:
* gio/src/seekable.hg:
* gio/src/unixinputstream.hg:
* gio/src/unixoutputstream.hg: Put these in a Streams doxygen group. 
We should think of some more groups, maybe by looking at the C 
documentation.

svn path=/trunk/; revision=630

1 files changed, 12 insertions, 0 deletions

diff --git a/gio/src/bufferedoutputstream.hg b/gio/src/bufferedoutputstream.hg
index 75ade8fd..e9c840de 100644
--- a/gio/src/bufferedoutputstream.hg
+++ b/gio/src/bufferedoutputstream.hg
@@ -26,6 +26,18 @@ _PINCLUDE(giomm/private/filteroutputstream_p.h)
 namespace Gio
 {
 
+/** The buffered output stream implements FilterOutputStream and provides for buffered writes.
+ * By default, BufferedOutputStream's buffer size is set at 4 kilobytes, but you 
+ * can specify this to the constructor.
+ *
+ * To get the size of a buffer within a buffered input stream, use get_buffer_size(). 
+ * To change the size of a buffered output stream's buffer, use set_buffer_size(). 
+ * Note that the buffer's size cannot be reduced below the size of the data within the buffer.
+ *
+ * @ingroup Streams
+ *
+ * @newin2p16
+ */
 class BufferedOutputStream : public Gio::FilterOutputStream
 {
   _CLASS_GOBJECT(BufferedOutputStream, GBufferedOutputStream, G_BUFFERED_OUTPUT_STREAM, Gio::FilterOutputStream, GFilterOutputStream)