glibmm r630 - in trunk: . gio/src

[murrayc svn gnome org]

Author: murrayc
Date: Mon Mar  3 21:29:18 2008
New Revision: 630
URL: http://svn.gnome.org/viewvc/glibmm?rev=630&view=rev

Log:
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.

Modified:
   trunk/ChangeLog
   trunk/gio/src/bufferedinputstream.hg
   trunk/gio/src/bufferedoutputstream.hg
   trunk/gio/src/datainputstream.hg
   trunk/gio/src/dataoutputstream.hg
   trunk/gio/src/fileinputstream.hg
   trunk/gio/src/fileoutputstream.hg
   trunk/gio/src/filterinputstream.hg
   trunk/gio/src/filteroutputstream.hg
   trunk/gio/src/inputstream.hg
   trunk/gio/src/memoryinputstream.hg
   trunk/gio/src/mount.hg
   trunk/gio/src/outputstream.hg
   trunk/gio/src/seekable.hg
   trunk/gio/src/unixinputstream.hg
   trunk/gio/src/unixoutputstream.hg

Modified: trunk/gio/src/bufferedinputstream.hg
==============================================================================
--- trunk/gio/src/bufferedinputstream.hg	(original)
+++ trunk/gio/src/bufferedinputstream.hg	Mon Mar  3 21:29:18 2008
@@ -26,6 +26,22 @@
 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)

Modified: trunk/gio/src/bufferedoutputstream.hg
==============================================================================
--- trunk/gio/src/bufferedoutputstream.hg	(original)
+++ trunk/gio/src/bufferedoutputstream.hg	Mon Mar  3 21:29:18 2008
@@ -26,6 +26,18 @@
 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)

Modified: trunk/gio/src/datainputstream.hg
==============================================================================
--- trunk/gio/src/datainputstream.hg	(original)
+++ trunk/gio/src/datainputstream.hg	Mon Mar  3 21:29:18 2008
@@ -30,6 +30,8 @@
  * 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

Modified: trunk/gio/src/dataoutputstream.hg
==============================================================================
--- trunk/gio/src/dataoutputstream.hg	(original)
+++ trunk/gio/src/dataoutputstream.hg	Mon Mar  3 21:29:18 2008
@@ -30,6 +30,8 @@
  * 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

Modified: trunk/gio/src/fileinputstream.hg
==============================================================================
--- trunk/gio/src/fileinputstream.hg	(original)
+++ trunk/gio/src/fileinputstream.hg	Mon Mar  3 21:29:18 2008
@@ -35,6 +35,8 @@
  * 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 

Modified: trunk/gio/src/fileoutputstream.hg
==============================================================================
--- trunk/gio/src/fileoutputstream.hg	(original)
+++ trunk/gio/src/fileoutputstream.hg	Mon Mar  3 21:29:18 2008
@@ -38,6 +38,7 @@
  * file system of the file supports these operations.
  * Use the methods of the Seekable base class for seeking and positioning. 
  * 
+ * @ingroup Streams
  *
  * @newin2p16
  */

Modified: trunk/gio/src/filterinputstream.hg
==============================================================================
--- trunk/gio/src/filterinputstream.hg	(original)
+++ trunk/gio/src/filterinputstream.hg	Mon Mar  3 21:29:18 2008
@@ -26,6 +26,14 @@
 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)

Modified: trunk/gio/src/filteroutputstream.hg
==============================================================================
--- trunk/gio/src/filteroutputstream.hg	(original)
+++ trunk/gio/src/filteroutputstream.hg	Mon Mar  3 21:29:18 2008
@@ -26,6 +26,14 @@
 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)

Modified: trunk/gio/src/inputstream.hg
==============================================================================
--- trunk/gio/src/inputstream.hg	(original)
+++ trunk/gio/src/inputstream.hg	Mon Mar  3 21:29:18 2008
@@ -32,6 +32,8 @@
 
 /** Base class for implementing streaming input.
  *
+ * @ingroup Streams
+ *
  * @newin2p16
  */
 class InputStream : public Glib::Object

Modified: trunk/gio/src/memoryinputstream.hg
==============================================================================
--- trunk/gio/src/memoryinputstream.hg	(original)
+++ trunk/gio/src/memoryinputstream.hg	Mon Mar  3 21:29:18 2008
@@ -26,7 +26,9 @@
 namespace Gio
 {
 
-/** MemoryInputStream implements InputStream for arbitrary memory chunks
+/** MemoryInputStream implements InputStream for arbitrary memory chunks.
+ *
+ * @ingroup Streams
  *
  * @newin2p16
  */

Modified: trunk/gio/src/mount.hg
==============================================================================
--- trunk/gio/src/mount.hg	(original)
+++ trunk/gio/src/mount.hg	Mon Mar  3 21:29:18 2008
@@ -45,6 +45,8 @@
  * 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

Modified: trunk/gio/src/outputstream.hg
==============================================================================
--- trunk/gio/src/outputstream.hg	(original)
+++ trunk/gio/src/outputstream.hg	Mon Mar  3 21:29:18 2008
@@ -32,6 +32,8 @@
 
 /** Base class for implementing streaming output.
  *
+ * @ingroup Streams
+ *
  * @newin2p16
  */
 class OutputStream : public Glib::Object

Modified: trunk/gio/src/seekable.hg
==============================================================================
--- trunk/gio/src/seekable.hg	(original)
+++ trunk/gio/src/seekable.hg	Mon Mar  3 21:29:18 2008
@@ -39,6 +39,8 @@
  * truncating, use can_truncate(). To truncate a stream, use 
  * truncate().
  *
+ * @ingroup Streams
+ *
  * @newin2p16
  */
 class Seekable : public Glib::Interface

Modified: trunk/gio/src/unixinputstream.hg
==============================================================================
--- trunk/gio/src/unixinputstream.hg	(original)
+++ trunk/gio/src/unixinputstream.hg	Mon Mar  3 21:29:18 2008
@@ -30,6 +30,8 @@
  * 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

Modified: trunk/gio/src/unixoutputstream.hg
==============================================================================
--- trunk/gio/src/unixoutputstream.hg	(original)
+++ trunk/gio/src/unixoutputstream.hg	Mon Mar  3 21:29:18 2008
@@ -25,11 +25,12 @@
 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