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

Add GI annotations to GData{Input|Output}Stream

Browse Source
This commit is contained in:
Pavel Holejsovsky 2010-12-21 18:00:48 +01:00
parent e78c27256a
commit 5ea4fa75bd
2 changed files with 59 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
gio/gdatainputstream.c
View File

@ -325,7 +325,7 @@ read_data (GDataInputStream *stream,
/** /**
* g_data_input_stream_read_byte: * g_data_input_stream_read_byte:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads an unsigned 8-bit/1-byte value from @stream. * Reads an unsigned 8-bit/1-byte value from @stream.
@ -352,7 +352,7 @@ g_data_input_stream_read_byte (GDataInputStream *stream,
/** /**
* g_data_input_stream_read_int16: * g_data_input_stream_read_int16:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads a 16-bit/2-byte value from @stream. * Reads a 16-bit/2-byte value from @stream.
@ -396,7 +396,7 @@ g_data_input_stream_read_int16 (GDataInputStream *stream,
/** /**
* g_data_input_stream_read_uint16: * g_data_input_stream_read_uint16:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads an unsigned 16-bit/2-byte value from @stream. * Reads an unsigned 16-bit/2-byte value from @stream.
@ -440,7 +440,7 @@ g_data_input_stream_read_uint16 (GDataInputStream *stream,
/** /**
* g_data_input_stream_read_int32: * g_data_input_stream_read_int32:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads a signed 32-bit/4-byte value from @stream. * Reads a signed 32-bit/4-byte value from @stream.
@ -488,7 +488,7 @@ g_data_input_stream_read_int32 (GDataInputStream *stream,
/** /**
* g_data_input_stream_read_uint32: * g_data_input_stream_read_uint32:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads an unsigned 32-bit/4-byte value from @stream. * Reads an unsigned 32-bit/4-byte value from @stream.
@ -536,7 +536,7 @@ g_data_input_stream_read_uint32 (GDataInputStream *stream,
/** /**
* g_data_input_stream_read_int64: * g_data_input_stream_read_int64:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads a 64-bit/8-byte value from @stream. * Reads a 64-bit/8-byte value from @stream.
@ -584,7 +584,7 @@ g_data_input_stream_read_int64 (GDataInputStream *stream,
/** /**
* g_data_input_stream_read_uint64: * g_data_input_stream_read_uint64:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads an unsigned 64-bit/8-byte value from @stream. * Reads an unsigned 64-bit/8-byte value from @stream.
@ -730,8 +730,8 @@ scan_for_newline (GDataInputStream *stream,
/** /**
* g_data_input_stream_read_line: * g_data_input_stream_read_line:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @length: a #gsize to get the length of the data read in. * @length: (out): a #gsize to get the length of the data read in.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads a line from the data input stream. * Reads a line from the data input stream.
@ -740,10 +740,11 @@ scan_for_newline (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
* *
* Returns: a string with the line that was read in (without the newlines). * Returns: (transfer full): a string with the line that was read in
* Set @length to a #gsize to get the length of the read line. * (without the newlines). Set @length to a #gsize to get the
* On an error, it will return %NULL and @error will be set. If there's no * length of the read line. On an error, it will return %NULL and
* content to read, it will still return %NULL, but @error won't be set. * @error will be set. If there's no content to read, it will
* still return %NULL, but @error won't be set.
**/ **/
char * char *
g_data_input_stream_read_line (GDataInputStream *stream, g_data_input_stream_read_line (GDataInputStream *stream,
@ -852,8 +853,8 @@ scan_for_chars (GDataInputStream *stream,
* g_data_input_stream_read_until: * g_data_input_stream_read_until:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @stop_chars: characters to terminate the read. * @stop_chars: characters to terminate the read.
* @length: a #gsize to get the length of the data read in. * @length: (out): a #gsize to get the length of the data read in.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Reads a string from the data input stream, up to the first * Reads a string from the data input stream, up to the first
@ -868,9 +869,10 @@ scan_for_chars (GDataInputStream *stream,
* g_data_input_stream_read_upto() instead, but note that that function * g_data_input_stream_read_upto() instead, but note that that function
* does not consume the stop character. * does not consume the stop character.
* *
* Returns: a string with the data that was read before encountering * Returns: (transfer full): a string with the data that was read
* any of the stop characters. Set @length to a #gsize to get the length * before encountering any of the stop characters. Set @length to
* of the string. This function will return %NULL on an error. * a #gsize to get the length of the string. This function will
* return %NULL on an error.
*/ */
char * char *
g_data_input_stream_read_until (GDataInputStream *stream, g_data_input_stream_read_until (GDataInputStream *stream,
@ -1099,9 +1101,9 @@ g_data_input_stream_read_finish (GDataInputStream *stream,
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @io_priority: the <link linkend="io-priority">I/O priority</link> * @io_priority: the <link linkend="io-priority">I/O priority</link>
* of the request. * of the request.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: callback to call when the request is satisfied. * @callback: (scope async): callback to call when the request is satisfied.
* @user_data: the data to pass to callback function. * @user_data: (closure): the data to pass to callback function.
* *
* The asynchronous version of g_data_input_stream_read_line(). It is * The asynchronous version of g_data_input_stream_read_line(). It is
* an error to have two outstanding calls to this function. * an error to have two outstanding calls to this function.
@ -1133,9 +1135,9 @@ g_data_input_stream_read_line_async (GDataInputStream *stream,
* @stop_chars: characters to terminate the read. * @stop_chars: characters to terminate the read.
* @io_priority: the <link linkend="io-priority">I/O priority</link> * @io_priority: the <link linkend="io-priority">I/O priority</link>
* of the request. * of the request.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: callback to call when the request is satisfied. * @callback: (scope async): callback to call when the request is satisfied.
* @user_data: the data to pass to callback function. * @user_data: (closure): the data to pass to callback function.
* *
* The asynchronous version of g_data_input_stream_read_until(). * The asynchronous version of g_data_input_stream_read_until().
* It is an error to have two outstanding calls to this function. * It is an error to have two outstanding calls to this function.
@ -1176,16 +1178,17 @@ g_data_input_stream_read_until_async (GDataInputStream *stream,
* g_data_input_stream_read_line_finish: * g_data_input_stream_read_line_finish:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @result: the #GAsyncResult that was provided to the callback. * @result: the #GAsyncResult that was provided to the callback.
* @length: a #gsize to get the length of the data read in. * @length: (out): a #gsize to get the length of the data read in.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Finish an asynchronous call started by * Finish an asynchronous call started by
* g_data_input_stream_read_line_async(). * g_data_input_stream_read_line_async().
* *
* Returns: a string with the line that was read in (without the newlines). * Returns: (transfer full): a string with the line that was read in
* Set @length to a #gsize to get the length of the read line. * (without the newlines). Set @length to a #gsize to get the
* On an error, it will return %NULL and @error will be set. If there's no * length of the read line. On an error, it will return %NULL and
* content to read, it will still return %NULL, but @error won't be set. * @error will be set. If there's no content to read, it will
* still return %NULL, but @error won't be set.
* *
* Since: 2.20 * Since: 2.20
*/ */
@ -1206,7 +1209,7 @@ g_data_input_stream_read_line_finish (GDataInputStream *stream,
* g_data_input_stream_read_until_finish: * g_data_input_stream_read_until_finish:
* @stream: a given #GDataInputStream. * @stream: a given #GDataInputStream.
* @result: the #GAsyncResult that was provided to the callback. * @result: the #GAsyncResult that was provided to the callback.
* @length: a #gsize to get the length of the data read in. * @length: (out): a #gsize to get the length of the data read in.
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Finish an asynchronous call started by * Finish an asynchronous call started by
@ -1214,9 +1217,10 @@ g_data_input_stream_read_line_finish (GDataInputStream *stream,
* *
* Since: 2.20 * Since: 2.20
* *
* Returns: a string with the data that was read before encountering * Returns: (transfer full): a string with the data that was read
* any of the stop characters. Set @length to a #gsize to get the length * before encountering any of the stop characters. Set @length to
* of the string. This function will return %NULL on an error. * a #gsize to get the length of the string. This function will
* return %NULL on an error.
*/ */
gchar * gchar *
g_data_input_stream_read_until_finish (GDataInputStream *stream, g_data_input_stream_read_until_finish (GDataInputStream *stream,
@ -1237,8 +1241,8 @@ g_data_input_stream_read_until_finish (GDataInputStream *stream,
* @stop_chars: characters to terminate the read * @stop_chars: characters to terminate the read
* @stop_chars_len: length of @stop_chars. May be -1 if @stop_chars is * @stop_chars_len: length of @stop_chars. May be -1 if @stop_chars is
* nul-terminated * nul-terminated
* @length: a #gsize to get the length of the data read in * @length: (out): a #gsize to get the length of the data read in
* @cancellable: optional #GCancellable object, %NULL to ignore * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @error: #GError for error reporting * @error: #GError for error reporting
* *
* Reads a string from the data input stream, up to the first * Reads a string from the data input stream, up to the first
@ -1252,9 +1256,10 @@ g_data_input_stream_read_until_finish (GDataInputStream *stream,
* Note that @stop_chars may contain '\0' if @stop_chars_len is * Note that @stop_chars may contain '\0' if @stop_chars_len is
* specified. * specified.
* *
* Returns: a string with the data that was read before encountering * Returns: (transfer full): a string with the data that was read
* any of the stop characters. Set @length to a #gsize to get the length * before encountering any of the stop characters. Set @length to
* of the string. This function will return %NULL on an error * a #gsize to get the length of the string. This function will
* return %NULL on an error
* *
* Since: 2.24 * Since: 2.24
*/ */
@ -1330,9 +1335,9 @@ g_data_input_stream_read_upto (GDataInputStream *stream,
* nul-terminated * nul-terminated
* @io_priority: the <link linkend="io-priority">I/O priority</link> * @io_priority: the <link linkend="io-priority">I/O priority</link>
* of the request. * of the request.
* @cancellable: optional #GCancellable object, %NULL to ignore * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @callback: callback to call when the request is satisfied * @callback: (scope async): callback to call when the request is satisfied
* @user_data: the data to pass to callback function * @user_data: (closure): the data to pass to callback function
* *
* The asynchronous version of g_data_input_stream_read_upto(). * The asynchronous version of g_data_input_stream_read_upto().
* It is an error to have two outstanding calls to this function. * It is an error to have two outstanding calls to this function.
@ -1373,7 +1378,7 @@ g_data_input_stream_read_upto_async (GDataInputStream *stream,
* g_data_input_stream_read_upto_finish: * g_data_input_stream_read_upto_finish:
* @stream: a #GDataInputStream * @stream: a #GDataInputStream
* @result: the #GAsyncResult that was provided to the callback * @result: the #GAsyncResult that was provided to the callback
* @length: a #gsize to get the length of the data read in * @length: (out): a #gsize to get the length of the data read in
* @error: #GError for error reporting * @error: #GError for error reporting
* *
* Finish an asynchronous call started by * Finish an asynchronous call started by
@ -1383,9 +1388,10 @@ g_data_input_stream_read_upto_async (GDataInputStream *stream,
* stop character. You have to use g_data_input_stream_read_byte() to * stop character. You have to use g_data_input_stream_read_byte() to
* get it before calling g_data_input_stream_read_upto_async() again. * get it before calling g_data_input_stream_read_upto_async() again.
* *
* Returns: a string with the data that was read before encountering * Returns: (transfer full): a string with the data that was read
* any of the stop characters. Set @length to a #gsize to get the length * before encountering any of the stop characters. Set @length to
* of the string. This function will return %NULL on an error. * a #gsize to get the length of the string. This function will
* return %NULL on an error.
* *
* Since: 2.24 * Since: 2.24
*/ */

16
gio/gdataoutputstream.c
View File

@ -210,7 +210,7 @@ g_data_output_stream_get_byte_order (GDataOutputStream *stream)
* g_data_output_stream_put_byte: * g_data_output_stream_put_byte:
* @stream: a #GDataOutputStream. * @stream: a #GDataOutputStream.
* @data: a #guchar. * @data: a #guchar.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError, %NULL to ignore. * @error: a #GError, %NULL to ignore.
* *
* Puts a byte into the output stream. * Puts a byte into the output stream.
@ -237,7 +237,7 @@ g_data_output_stream_put_byte (GDataOutputStream *stream,
* g_data_output_stream_put_int16: * g_data_output_stream_put_int16:
* @stream: a #GDataOutputStream. * @stream: a #GDataOutputStream.
* @data: a #gint16. * @data: a #gint16.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError, %NULL to ignore. * @error: a #GError, %NULL to ignore.
* *
* Puts a signed 16-bit integer into the output stream. * Puts a signed 16-bit integer into the output stream.
@ -277,7 +277,7 @@ g_data_output_stream_put_int16 (GDataOutputStream *stream,
* g_data_output_stream_put_uint16: * g_data_output_stream_put_uint16:
* @stream: a #GDataOutputStream. * @stream: a #GDataOutputStream.
* @data: a #guint16. * @data: a #guint16.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError, %NULL to ignore. * @error: a #GError, %NULL to ignore.
* *
* Puts an unsigned 16-bit integer into the output stream. * Puts an unsigned 16-bit integer into the output stream.
@ -317,7 +317,7 @@ g_data_output_stream_put_uint16 (GDataOutputStream *stream,
* g_data_output_stream_put_int32: * g_data_output_stream_put_int32:
* @stream: a #GDataOutputStream. * @stream: a #GDataOutputStream.
* @data: a #gint32. * @data: a #gint32.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError, %NULL to ignore. * @error: a #GError, %NULL to ignore.
* *
* Puts a signed 32-bit integer into the output stream. * Puts a signed 32-bit integer into the output stream.
@ -357,7 +357,7 @@ g_data_output_stream_put_int32 (GDataOutputStream *stream,
* g_data_output_stream_put_uint32: * g_data_output_stream_put_uint32:
* @stream: a #GDataOutputStream. * @stream: a #GDataOutputStream.
* @data: a #guint32. * @data: a #guint32.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError, %NULL to ignore. * @error: a #GError, %NULL to ignore.
* *
* Puts an unsigned 32-bit integer into the stream. * Puts an unsigned 32-bit integer into the stream.
@ -397,7 +397,7 @@ g_data_output_stream_put_uint32 (GDataOutputStream *stream,
* g_data_output_stream_put_int64: * g_data_output_stream_put_int64:
* @stream: a #GDataOutputStream. * @stream: a #GDataOutputStream.
* @data: a #gint64. * @data: a #gint64.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError, %NULL to ignore. * @error: a #GError, %NULL to ignore.
* *
* Puts a signed 64-bit integer into the stream. * Puts a signed 64-bit integer into the stream.
@ -437,7 +437,7 @@ g_data_output_stream_put_int64 (GDataOutputStream *stream,
* g_data_output_stream_put_uint64: * g_data_output_stream_put_uint64:
* @stream: a #GDataOutputStream. * @stream: a #GDataOutputStream.
* @data: a #guint64. * @data: a #guint64.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError, %NULL to ignore. * @error: a #GError, %NULL to ignore.
* *
* Puts an unsigned 64-bit integer into the stream. * Puts an unsigned 64-bit integer into the stream.
@ -477,7 +477,7 @@ g_data_output_stream_put_uint64 (GDataOutputStream *stream,
* g_data_output_stream_put_string: * g_data_output_stream_put_string:
* @stream: a #GDataOutputStream. * @stream: a #GDataOutputStream.
* @str: a string. * @str: a string.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: a #GError, %NULL to ignore. * @error: a #GError, %NULL to ignore.
* *
* Puts a string into the output stream. * Puts a string into the output stream.