Explain I/O priorieties
[platform/upstream/glib.git] / gio / gfilteroutputstream.c
index ca41be5..534ea7c 100644 (file)
 #include "goutputstream.h"
 #include "glibintl.h"
 
+#include "gioalias.h"
+
+/**
+ * SECTION:gfilteroutputstream
+ * @short_description: Filter Output Stream
+ *
+ **/
+
 enum {
   PROP_0,
   PROP_BASE_STREAM
@@ -120,10 +128,10 @@ g_filter_output_stream_class_init (GFilterOutputStreamClass *klass)
 }
 
 static void
-g_filter_output_stream_set_property (GObject         *object,
-                                     guint            prop_id,
-                                     const GValue    *value,
-                                     GParamSpec      *pspec)
+g_filter_output_stream_set_property (GObject      *object,
+                                     guint         prop_id,
+                                     const GValue *value,
+                                     GParamSpec   *pspec)
 {
   GFilterOutputStream *filter_stream;
   GObject *obj;
@@ -170,7 +178,7 @@ g_filter_output_stream_get_property (GObject    *object,
 static void
 g_filter_output_stream_dispose (GObject *object)
 {
-  GFilterOutputStream        *stream;
+  GFilterOutputStream *stream;
 
   stream = G_FILTER_OUTPUT_STREAM (object);
 
@@ -189,6 +197,14 @@ g_filter_output_stream_init (GFilterOutputStream *stream)
 {
 }
 
+/**
+ * g_filter_output_stream_get_base_stream:
+ * @stream: a #GFilterOutputStream.
+ * 
+ * Gets the base stream for the filter stream.
+ *
+ * Returns: a #GOutputStream.
+ **/
 GOutputStream *
 g_filter_output_stream_get_base_stream (GFilterOutputStream *stream)
 {
@@ -198,11 +214,11 @@ g_filter_output_stream_get_base_stream (GFilterOutputStream *stream)
 }
 
 static gssize
-g_filter_output_stream_write (GOutputStream *stream,
-                              const void *buffer,
-                              gsize          count,
-                              GCancellable  *cancellable,
-                              GError       **error)
+g_filter_output_stream_write (GOutputStream  *stream,
+                              const void     *buffer,
+                              gsize           count,
+                              GCancellable   *cancellable,
+                              GError        **error)
 {
   GFilterOutputStream *filter_stream;
   gssize nwritten;
@@ -219,9 +235,9 @@ g_filter_output_stream_write (GOutputStream *stream,
 }
 
 static gboolean
-g_filter_output_stream_flush (GOutputStream    *stream,
-                              GCancellable  *cancellable,
-                              GError          **error)
+g_filter_output_stream_flush (GOutputStream  *stream,
+                              GCancellable   *cancellable,
+                              GError        **error)
 {
   GFilterOutputStream *filter_stream;
   gboolean res;
@@ -253,13 +269,13 @@ g_filter_output_stream_close (GOutputStream  *stream,
 }
 
 static void
-g_filter_output_stream_write_async (GOutputStream        *stream,
-                                    const void           *buffer,
-                                    gsize                 count,
-                                    int                   io_priority,
-                                    GCancellable         *cancellable,
-                                    GAsyncReadyCallback   callback,
-                                    gpointer              data)
+g_filter_output_stream_write_async (GOutputStream       *stream,
+                                    const void          *buffer,
+                                    gsize                count,
+                                    int                  io_priority,
+                                    GCancellable        *cancellable,
+                                    GAsyncReadyCallback  callback,
+                                    gpointer             data)
 {
   GFilterOutputStream *filter_stream;
 
@@ -276,9 +292,9 @@ g_filter_output_stream_write_async (GOutputStream        *stream,
 }
 
 static gssize
-g_filter_output_stream_write_finish (GOutputStream        *stream,
-                                     GAsyncResult         *result,
-                                     GError              **error)
+g_filter_output_stream_write_finish (GOutputStream  *stream,
+                                     GAsyncResult   *result,
+                                     GError        **error)
 {
   GFilterOutputStream *filter_stream;
   gssize nwritten;
@@ -293,11 +309,11 @@ g_filter_output_stream_write_finish (GOutputStream        *stream,
 }
 
 static void
-g_filter_output_stream_flush_async (GOutputStream        *stream,
-                                    int                   io_priority,
-                                    GCancellable         *cancellable,
-                                    GAsyncReadyCallback   callback,
-                                    gpointer              data)
+g_filter_output_stream_flush_async (GOutputStream       *stream,
+                                    int                  io_priority,
+                                    GCancellable        *cancellable,
+                                    GAsyncReadyCallback  callback,
+                                    gpointer             data)
 {
   GFilterOutputStream *filter_stream;
 
@@ -311,9 +327,9 @@ g_filter_output_stream_flush_async (GOutputStream        *stream,
 }
 
 static gboolean
-g_filter_output_stream_flush_finish (GOutputStream        *stream,
-                                     GAsyncResult         *result,
-                                     GError              **error)
+g_filter_output_stream_flush_finish (GOutputStream  *stream,
+                                     GAsyncResult   *result,
+                                     GError        **error)
 {
   GFilterOutputStream *filter_stream;
   gboolean res;
@@ -328,11 +344,11 @@ g_filter_output_stream_flush_finish (GOutputStream        *stream,
 }
 
 static void
-g_filter_output_stream_close_async (GOutputStream        *stream,
-                                    int                   io_priority,
-                                    GCancellable         *cancellable,
-                                    GAsyncReadyCallback   callback,
-                                    gpointer              data)
+g_filter_output_stream_close_async (GOutputStream       *stream,
+                                    int                  io_priority,
+                                    GCancellable        *cancellable,
+                                    GAsyncReadyCallback  callback,
+                                    gpointer             data)
 {
   GFilterOutputStream *filter_stream;
 
@@ -346,9 +362,9 @@ g_filter_output_stream_close_async (GOutputStream        *stream,
 }
 
 static gboolean
-g_filter_output_stream_close_finish (GOutputStream        *stream,
-                                     GAsyncResult         *result,
-                                     GError              **error)
+g_filter_output_stream_close_finish (GOutputStream  *stream,
+                                     GAsyncResult   *result,
+                                     GError        **error)
 {
   GFilterOutputStream *filter_stream;
   gboolean res;
@@ -362,5 +378,5 @@ g_filter_output_stream_close_finish (GOutputStream        *stream,
   return res;
 }
 
-
-/* vim: ts=2 sw=2 et */
+#define __G_FILTER_OUTPUT_STREAM_C__
+#include "gioaliasdef.c"