Add GI annotations to GMemory{Input|Output}Stream
authorPavel Holejsovsky <pholejs@src.gnome.org>
Mon, 27 Dec 2010 15:47:26 +0000 (16:47 +0100)
committerPavel Holejsovsky <pholejs@src.gnome.org>
Mon, 27 Dec 2010 15:47:26 +0000 (16:47 +0100)
gio/gmemoryinputstream.c
gio/gmemoryoutputstream.c

index 397c6a5..9107b22 100644 (file)
@@ -203,9 +203,9 @@ g_memory_input_stream_new (void)
 
 /**
  * g_memory_input_stream_new_from_data:
- * @data: input data
+ * @data: (array length=len) (element-type guint8): input data
  * @len: length of the data, may be -1 if @data is a nul-terminated string
- * @destroy: function that is called to free @data, or %NULL
+ * @destroy: (allow-none): function that is called to free @data, or %NULL
  *
  * Creates a new #GMemoryInputStream with data in memory of a given size.
  * 
@@ -229,9 +229,9 @@ g_memory_input_stream_new_from_data (const void     *data,
 /**
  * g_memory_input_stream_add_data:
  * @stream: a #GMemoryInputStream
- * @data: input data
+ * @data: (array length=len) (element-type guint8): input data
  * @len: length of the data, may be -1 if @data is a nul-terminated string
- * @destroy: function that is called to free @data, or %NULL
+ * @destroy: (allow-none): function that is called to free @data, or %NULL
  *
  * Appends @data to data that can be read from the input stream
  */
index 3291be4..b6b532d 100644 (file)
@@ -194,7 +194,7 @@ g_memory_output_stream_class_init (GMemoryOutputStreamClass *klass)
                                                        G_PARAM_STATIC_STRINGS));
 
   /**
-   * GMemoryOutputStream:realloc-function:
+   * GMemoryOutputStream:realloc-function: (skip)
    *
    * Function with realloc semantics called to enlarge the buffer.
    *
@@ -209,7 +209,7 @@ g_memory_output_stream_class_init (GMemoryOutputStreamClass *klass)
                                                          G_PARAM_STATIC_STRINGS));
 
   /**
-   * GMemoryOutputStream:destroy-function:
+   * GMemoryOutputStream:destroy-function: (skip)
    *
    * Function called with the buffer as argument when the stream is destroyed.
    *
@@ -328,7 +328,7 @@ g_memory_output_stream_init (GMemoryOutputStream *stream)
 }
 
 /**
- * g_memory_output_stream_new:
+ * g_memory_output_stream_new: (skip)
  * @data: pointer to a chunk of memory to use, or %NULL
  * @size: the size of @data
  * @realloc_function: a function with realloc() semantics (like g_realloc())
@@ -376,7 +376,7 @@ g_memory_output_stream_new (gpointer       data,
 }
 
 /**
- * g_memory_output_stream_get_data: (skip)
+ * g_memory_output_stream_get_data:
  * @ostream: a #GMemoryOutputStream
  *
  * Gets any loaded data from the @ostream.
@@ -384,7 +384,7 @@ g_memory_output_stream_new (gpointer       data,
  * Note that the returned pointer may become invalid on the next
  * write or truncate operation on the stream.
  *
- * Returns: pointer to the stream's data
+ * Returns: (transfer none): pointer to the stream's data
  **/
 gpointer
 g_memory_output_stream_get_data (GMemoryOutputStream *ostream)
@@ -398,7 +398,7 @@ g_memory_output_stream_get_data (GMemoryOutputStream *ostream)
  * g_memory_output_stream_get_size:
  * @ostream: a #GMemoryOutputStream
  *
- * Gets the size of the currently allocated data area (availible from
+ * Gets the size of the currently allocated data area (available from
  * g_memory_output_stream_get_data()). If the stream isn't
  * growable (no realloc was passed to g_memory_output_stream_new()) then
  * this is the maximum size of the stream and further writes