luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-28 20:04:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Bumps documentation to 93% symbol coverage, touching most

Browse Source 
of the public files. Fixes broken function documentation prototypes. 
	Fixes GCancellable inaccuracies. Removes unnecessary incomplete 
	gtk-doc headers in private files.

svn path=/trunk/; revision=5953
This commit is contained in:
Andrew Walton
2007-11-27 14:00:13 +00:00
parent 6d071b4ab6
commit 5247f12f36
88 changed files with 3708 additions and 747 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
gio/gdataoutputstream.c
View File

@@ -25,6 +25,18 @@
#include "gdataoutputstream.h"
#include "glibintl.h"
/**
* SECTION:gdataoutputstream
* @short_description: Data Output Stream.
* @see_also: #GOutputStream.
*
* Data output stream implements #GOutputStream and includes functions for
* writing data directly to an output stream.
*
**/
struct _GDataOutputStreamPrivate {
GDataStreamByteOrder byte_order;
};
@@ -116,6 +128,8 @@ g_data_output_stream_init (GDataOutputStream *stream)
* g_data_output_stream_new:
* @base_stream: a #GOutputStream.
*
* Creates a new data output stream for @base_stream.
*
* Returns: #GDataOutputStream.
**/
GDataOutputStream *
@@ -134,9 +148,11 @@ g_data_output_stream_new (GOutputStream *base_stream)
/**
* g_data_output_stream_set_byte_order:
* @stream: a #GDataOutputStream. a #GDataOutputStream.
* @stream: a #GDataOutputStream.
* @order: a %GDataStreamByteOrder.
*
* Sets the byte order of the data output stream to @order.
*
**/
void
g_data_output_stream_set_byte_order (GDataOutputStream *stream,
@@ -149,9 +165,11 @@ g_data_output_stream_set_byte_order (GDataOutputStream *stream,
/**
* g_data_output_stream_get_byte_order:
* @stream: a #GDataOutputStream. a #GDataOutputStream.
* @stream: a #GDataOutputStream.
*
* Returns: the %GDataStreamByteOrder for the @stream.
* Gets the byte order for the stream.
*
* Returns: the #GDataStreamByteOrder for the @stream.
**/
GDataStreamByteOrder
g_data_output_stream_get_byte_order (GDataOutputStream *stream)
@@ -166,7 +184,9 @@ g_data_output_stream_get_byte_order (GDataOutputStream *stream)
* @data_stream: a #GDataOutputStream.
* @data: a #guchar.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError.
* @error: a #GError, %NULL to ignore.
*
* Puts a byte into the output stream.
*
* Returns: %TRUE if @data was successfully added to the @stream.
**/
@@ -188,10 +208,12 @@ g_data_output_stream_put_byte (GDataOutputStream *data_stream,
/**
* g_data_output_stream_put_int16:
* @stream: a #GDataOutputStream. a #GDataOutputStream.
* @stream: a #GDataOutputStream.
* @data: a #gint16.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError.
* @error: a #GError, %NULL to ignore.
*
* Puts a signed 16-bit integer into the output stream.
*
* Returns: %TRUE if @data was successfully added to the @stream.
**/
@@ -226,10 +248,12 @@ g_data_output_stream_put_int16 (GDataOutputStream *stream,
/**
* g_data_output_stream_put_uint16:
* @stream: a #GDataOutputStream. a #GDataOutputStream.
* @stream: a #GDataOutputStream.
* @data: a #guint16.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError.
* @error: a #GError, %NULL to ignore.
*
* Puts an unsigned 16-bit integer into the output stream.
*
* Returns: %TRUE if @data was successfully added to the @stream.
**/
@@ -264,10 +288,12 @@ g_data_output_stream_put_uint16 (GDataOutputStream *stream,
/**
* g_data_output_stream_put_int32:
* @stream: a #GDataOutputStream. a #GDataOutputStream.
* @stream: a #GDataOutputStream.
* @data: a #gint32.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError.
* @error: a #GError, %NULL to ignore.
*
* Puts a signed 32-bit integer into the output stream.
*
* Returns: %TRUE if @data was successfully added to the @stream.
**/
@@ -302,10 +328,12 @@ g_data_output_stream_put_int32 (GDataOutputStream *stream,
/**
* g_data_output_stream_put_uint32:
* @stream: a #GDataOutputStream. a #GDataOutputStream.
* @stream: a #GDataOutputStream.
* @data: a #guint32.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError.
* @error: a #GError, %NULL to ignore.
*
* Puts an unsigned 32-bit integer into the stream.
*
* Returns: %TRUE if @data was successfully added to the @stream.
**/
@@ -340,10 +368,12 @@ g_data_output_stream_put_uint32 (GDataOutputStream *stream,
/**
* g_data_output_stream_put_int64:
* @stream: a #GDataOutputStream. a #GDataOutputStream.
* @stream: a #GDataOutputStream.
* @data: a #gint64.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError.
* @error: a #GError, %NULL to ignore.
*
* Puts a signed 64-bit integer into the stream.
*
* Returns: %TRUE if @data was successfully added to the @stream.
**/
@@ -378,10 +408,12 @@ g_data_output_stream_put_int64 (GDataOutputStream *stream,
/**
* g_data_output_stream_put_uint64:
* @stream: a #GDataOutputStream. a #GDataOutputStream.
* @stream: a #GDataOutputStream.
* @data: a #guint64.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError.
* @error: a #GError, %NULL to ignore.
*
* Puts an unsigned 64-bit integer into the stream.
*
* Returns: %TRUE if @data was successfully added to the @stream.
**/
@@ -419,9 +451,11 @@ g_data_output_stream_put_uint64 (GDataOutputStream *stream,
* @stream: a #GDataOutputStream.
* @str: a string.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError.
* @error: a #GError, %NULL to ignore.
*
* Returns: %TRUE if @data was successfully added to the @stream.
* Puts a string into the output stream.
*
* Returns: %TRUE if @string was successfully added to the @stream.
**/
gboolean
g_data_output_stream_put_string (GDataOutputStream *stream,