diff options
author | Murray Cumming <murrayc@murrayc.com> | 2008-03-03 21:29:18 +0000 |
---|---|---|
committer | Murray Cumming <murrayc@src.gnome.org> | 2008-03-03 21:29:18 +0000 |
commit | b324bf30ab7c3dbf37f00ae94695b48291f2e701 (patch) | |
tree | f895247dddd5b89372bc1a50aa352f65a3990693 | |
parent | 8036fa4718306de4ccd47640a7fdbb3d4cfaa810 (diff) | |
download | glibmm-b324bf30ab7c3dbf37f00ae94695b48291f2e701.tar.gz |
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
-rw-r--r-- | ChangeLog | 20 | ||||
-rw-r--r-- | gio/src/bufferedinputstream.hg | 16 | ||||
-rw-r--r-- | gio/src/bufferedoutputstream.hg | 12 | ||||
-rw-r--r-- | gio/src/datainputstream.hg | 2 | ||||
-rw-r--r-- | gio/src/dataoutputstream.hg | 2 | ||||
-rw-r--r-- | gio/src/fileinputstream.hg | 2 | ||||
-rw-r--r-- | gio/src/fileoutputstream.hg | 1 | ||||
-rw-r--r-- | gio/src/filterinputstream.hg | 8 | ||||
-rw-r--r-- | gio/src/filteroutputstream.hg | 8 | ||||
-rw-r--r-- | gio/src/inputstream.hg | 2 | ||||
-rw-r--r-- | gio/src/memoryinputstream.hg | 4 | ||||
-rw-r--r-- | gio/src/mount.hg | 2 | ||||
-rw-r--r-- | gio/src/outputstream.hg | 2 | ||||
-rw-r--r-- | gio/src/seekable.hg | 2 | ||||
-rw-r--r-- | gio/src/unixinputstream.hg | 2 | ||||
-rw-r--r-- | gio/src/unixoutputstream.hg | 5 |
16 files changed, 87 insertions, 3 deletions
@@ -1,5 +1,25 @@ 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. + +2008-03-03 Murray Cumming <murrayc@murrayc.com> + * gio/src/file.ccg: * gio/src/file.hg: load_contents(), load_contents_finish(), load_partial_contents_finish(): Use char*& instead of char** for contents, diff --git a/gio/src/bufferedinputstream.hg b/gio/src/bufferedinputstream.hg index 6beb6240..34203b01 100644 --- a/gio/src/bufferedinputstream.hg +++ b/gio/src/bufferedinputstream.hg @@ -26,6 +26,22 @@ _PINCLUDE(giomm/private/filterinputstream_p.h) namespace Gio { +/** @defgroup Streams Stream Classes + * + */ + +/** The buffered input stream implements FilterInputStream and provides for buffered reads. + * By default, BufferedInputStream'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 input 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 BufferedInputStream : public Gio::FilterInputStream { _CLASS_GOBJECT(BufferedInputStream, GBufferedInputStream, G_BUFFERED_INPUT_STREAM, Gio::FilterInputStream, GFilterInputStream) 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) diff --git a/gio/src/datainputstream.hg b/gio/src/datainputstream.hg index 0ff255e7..b59f9cb3 100644 --- a/gio/src/datainputstream.hg +++ b/gio/src/datainputstream.hg @@ -30,6 +30,8 @@ namespace Gio * An implementation of BufferedInputStream that allows for high-level data * manipulation of arbitrary data (including binary operations). * + * @ingroup Streams + * * @newin2p16 */ class DataInputStream : public Gio::BufferedInputStream diff --git a/gio/src/dataoutputstream.hg b/gio/src/dataoutputstream.hg index 8c34b59e..c1b75ec2 100644 --- a/gio/src/dataoutputstream.hg +++ b/gio/src/dataoutputstream.hg @@ -30,6 +30,8 @@ namespace Gio * An implementation of BufferedOutputStream that allows for high-level data * manipulation of arbitrary data (including binary operations). * + * @ingroup Streams + * * @newin2p16 */ class DataOutputStream : public Gio::BufferedOutputStream diff --git a/gio/src/fileinputstream.hg b/gio/src/fileinputstream.hg index 15521cb0..68ba6cab 100644 --- a/gio/src/fileinputstream.hg +++ b/gio/src/fileinputstream.hg @@ -35,6 +35,8 @@ namespace Gio * provided the file system of the file allows it. * Use the methods of the Seekable base class for seeking and positioning. * + * @ingroup Streams + * * @newin2p16 */ class FileInputStream diff --git a/gio/src/fileoutputstream.hg b/gio/src/fileoutputstream.hg index 65a9b518..a8e1d48c 100644 --- a/gio/src/fileoutputstream.hg +++ b/gio/src/fileoutputstream.hg @@ -38,6 +38,7 @@ namespace Gio * file system of the file supports these operations. * Use the methods of the Seekable base class for seeking and positioning. * + * @ingroup Streams * * @newin2p16 */ diff --git a/gio/src/filterinputstream.hg b/gio/src/filterinputstream.hg index 9508ec37..ad2d6e51 100644 --- a/gio/src/filterinputstream.hg +++ b/gio/src/filterinputstream.hg @@ -26,6 +26,14 @@ _PINCLUDE(giomm/private/inputstream_p.h) namespace Gio { +//TODO: Proper documentation. + +/** Filter Input Stream. + * + * @ingroup Streams + * + * @newin2p16 + */ class FilterInputStream : public Gio::InputStream { _CLASS_GOBJECT(FilterInputStream, GFilterInputStream, G_FILTER_INPUT_STREAM, Gio::InputStream, GInputStream) diff --git a/gio/src/filteroutputstream.hg b/gio/src/filteroutputstream.hg index fe0907ed..f7311b36 100644 --- a/gio/src/filteroutputstream.hg +++ b/gio/src/filteroutputstream.hg @@ -26,6 +26,14 @@ _PINCLUDE(giomm/private/outputstream_p.h) namespace Gio { +//TODO: Proper documentation: + +/** Filter Output Stream. + * + * @ingroup Streams + * + * @newin2p16 + */ class FilterOutputStream : public Gio::OutputStream { _CLASS_GOBJECT(FilterOutputStream, GFilterOutputStream, G_FILTER_OUTPUT_STREAM, Gio::OutputStream, GOutputStream) diff --git a/gio/src/inputstream.hg b/gio/src/inputstream.hg index 7594d448..8b84ce92 100644 --- a/gio/src/inputstream.hg +++ b/gio/src/inputstream.hg @@ -32,6 +32,8 @@ namespace Gio /** Base class for implementing streaming input. * + * @ingroup Streams + * * @newin2p16 */ class InputStream : public Glib::Object diff --git a/gio/src/memoryinputstream.hg b/gio/src/memoryinputstream.hg index 7cfad118..6be10040 100644 --- a/gio/src/memoryinputstream.hg +++ b/gio/src/memoryinputstream.hg @@ -26,7 +26,9 @@ _PINCLUDE(giomm/private/inputstream_p.h) namespace Gio { -/** MemoryInputStream implements InputStream for arbitrary memory chunks +/** MemoryInputStream implements InputStream for arbitrary memory chunks. + * + * @ingroup Streams * * @newin2p16 */ diff --git a/gio/src/mount.hg b/gio/src/mount.hg index abf41338..8576b2a1 100644 --- a/gio/src/mount.hg +++ b/gio/src/mount.hg @@ -45,6 +45,8 @@ class Drive; * To unmount a Mount instance, first call unmount(). The callback slot will be called when the operation has resolved (either with success or failure), * and a AsyncReady structure will be passed to the callback. That callback should then call unmount_finish() with the AsyncReady data to see if the operation was completed successfully. * + * @ingroup Streams + * * @newin2p16 */ class Mount : public Glib::Interface diff --git a/gio/src/outputstream.hg b/gio/src/outputstream.hg index bdeb682f..5cd803c1 100644 --- a/gio/src/outputstream.hg +++ b/gio/src/outputstream.hg @@ -32,6 +32,8 @@ _WRAP_ENUM(OutputStreamSpliceFlags, GOutputStreamSpliceFlags, NO_GTYPE) /** Base class for implementing streaming output. * + * @ingroup Streams + * * @newin2p16 */ class OutputStream : public Glib::Object diff --git a/gio/src/seekable.hg b/gio/src/seekable.hg index ac07c4ad..86e9f78a 100644 --- a/gio/src/seekable.hg +++ b/gio/src/seekable.hg @@ -39,6 +39,8 @@ namespace Gio * truncating, use can_truncate(). To truncate a stream, use * truncate(). * + * @ingroup Streams + * * @newin2p16 */ class Seekable : public Glib::Interface diff --git a/gio/src/unixinputstream.hg b/gio/src/unixinputstream.hg index 88eee384..f1212f07 100644 --- a/gio/src/unixinputstream.hg +++ b/gio/src/unixinputstream.hg @@ -30,6 +30,8 @@ namespace Gio * descriptor, including asynchronous operations. The file descriptor must be * selectable, so it doesn't work with opened files. * + * @ingroup Streams + * * @newin2p16 */ class UnixInputStream : public Gio::InputStream diff --git a/gio/src/unixoutputstream.hg b/gio/src/unixoutputstream.hg index d552ca45..69d574c3 100644 --- a/gio/src/unixoutputstream.hg +++ b/gio/src/unixoutputstream.hg @@ -25,11 +25,12 @@ _PINCLUDE(giomm/private/outputstream_p.h) namespace Gio { -/** - * UnixOutputStream implements OutputStream for writing to a a unix file +/** UnixOutputStream implements OutputStream for writing to a a unix file * descriptor, including asynchronous operations. The file descriptor much be * selectable, so it doesn't work with opened files. * + * @ingroup Streams + * * @newin2p16 */ class UnixOutputStream : public Gio::OutputStream |