diff options
| author | A. Walton <awalton@svn.gnome.org> | 2007-12-09 15:51:12 +0000 |
|---|---|---|
| committer | Andrew Walton <awalton@src.gnome.org> | 2007-12-09 15:51:12 +0000 |
| commit | ab69ee2945af25672ad4bb48ae6ab5b87f0e06e2 (patch) | |
| tree | 422e5358327eab7385af277e9aeff02681d3727d /gio/gmemoryinputstream.c | |
| parent | b877c83cdcde2f7d26f9395d0b21230941cf190e (diff) | |
| download | glib-ab69ee2945af25672ad4bb48ae6ab5b87f0e06e2.tar.gz | |
More documentation cleanup and filling in missing information, bringing
2007-12-09 A. Walton <awalton@svn.gnome.org>
* gdesktopappinfo.c:
* gdrive.c:
* gdrive.h:
* gfile.c:
* gfile.h:
* gfileattribute.c:
* gfileenumerator.c:
* gioerror.c:
* gioscheduler.c:
* gioscheduler.h:
* gloadableicon.c:
* gmemoryinputstream.c:
* gmemoryoutputstream.c:
* goutputstream.h:
* gsimpleasyncresult.c:
More documentation cleanup and filling in missing information,
bringing
GIO to 99% symbol coverage.
svn path=/trunk/; revision=6077
Diffstat (limited to 'gio/gmemoryinputstream.c')
| -rw-r--r-- | gio/gmemoryinputstream.c | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/gio/gmemoryinputstream.c b/gio/gmemoryinputstream.c index 5274ab5f1..ca895b9e9 100644 --- a/gio/gmemoryinputstream.c +++ b/gio/gmemoryinputstream.c @@ -165,9 +165,11 @@ g_memory_input_stream_init (GMemoryInputStream *stream) /** * g_memory_input_stream_set_free_data: - * @stream: - * @free_data: + * @stream: a #GMemoryInputStream. + * @free_data: a #gboolean. If %TRUE, frees the data within @stream. * + * Sets if the data within the @stream should be freed when the stream + * is freed. **/ void g_memory_input_stream_set_free_data (GMemoryInputStream *stream, @@ -182,6 +184,8 @@ g_memory_input_stream_set_free_data (GMemoryInputStream *stream, * g_memory_input_stream_from_data: * @data: input data. * @len: length of the data. + * + * Creates a new #GMemoryInputStream with data in memory of a given size. * * Returns: new #GInputStream read from @data of @len bytes. **/ @@ -228,9 +232,11 @@ g_memory_input_stream_read (GInputStream *stream, /** * g_memory_input_stream_get_data: - * @stream: + * @stream: a #GMemoryInputStream * - * Returns: + * Gets a pointer to the data within the #GMemoryInputStream. + * + * Returns: a pointer to the memory in the @stream. **/ const void * g_memory_input_stream_get_data (GMemoryInputStream *stream) @@ -242,9 +248,12 @@ g_memory_input_stream_get_data (GMemoryInputStream *stream) /** * g_memory_input_stream_get_data_size: - * @stream: + * @stream: a #GMemoryInputStream * - * Returns: + * Gets the size of the data within the #GMemoryInputStream. + * + * Returns: a gsize with the size of the data in @stream, or -1 + * on error. **/ gsize g_memory_input_stream_get_data_size (GMemoryInputStream *stream) |