X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gio%2Fgdatainputstream.c;h=3753bd81b721656b2a52d386eb14614546141efd;hb=7e5e3e142f856ac80e83a9a5110b51aa4b5b0821;hp=0919cdd51f9d6a9329fd2e88d657ab1217929b90;hpb=078dbda148a81af1b3a76fbda72f089b963087f1;p=platform%2Fupstream%2Fglib.git diff --git a/gio/gdatainputstream.c b/gio/gdatainputstream.c index 0919cdd..3753bd8 100644 --- a/gio/gdatainputstream.c +++ b/gio/gdatainputstream.c @@ -735,12 +735,12 @@ scan_for_newline (GDataInputStream *stream, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: (transfer full) (array zero-terminated=1) (element-type guint8): a - * NUL terminated byte array with the line that was read in (without - * the newlines). Set @length to a #gsize to get the length of the - * read line. On an error, it will return %NULL and @error will be - * set. If there's no content to read, it will still return %NULL, - * but @error won't be set. + * Returns: (nullable) (transfer full) (array zero-terminated=1) (element-type guint8): + * a NUL terminated byte array with the line that was read in + * (without the newlines). Set @length to a #gsize to get the length + * of the read line. On an error, it will return %NULL and @error + * will be set. If there's no content to read, it will still return + * %NULL, but @error won't be set. **/ char * g_data_input_stream_read_line (GDataInputStream *stream, @@ -819,12 +819,13 @@ g_data_input_stream_read_line (GDataInputStream *stream, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: (transfer full): a NUL terminated UTF-8 string with the - * line that was read in (without the newlines). Set @length to a - * #gsize to get the length of the read line. On an error, it will - * return %NULL and @error will be set. For UTF-8 conversion errors, - * the set error domain is %G_CONVERT_ERROR. If there's no content to - * read, it will still return %NULL, but @error won't be set. + * Returns: (nullable) (transfer full): a NUL terminated UTF-8 string + * with the line that was read in (without the newlines). Set + * @length to a #gsize to get the length of the read line. On an + * error, it will return %NULL and @error will be set. For UTF-8 + * conversion errors, the set error domain is %G_CONVERT_ERROR. If + * there's no content to read, it will still return %NULL, but @error + * won't be set. * * Since: 2.30 **/ @@ -1114,8 +1115,7 @@ g_data_input_stream_read_finish (GDataInputStream *stream, /** * g_data_input_stream_read_line_async: * @stream: a given #GDataInputStream. - * @io_priority: the I/O priority - * of the request. + * @io_priority: the [I/O priority][io-priority] of the request * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @callback: (scope async): callback to call when the request is satisfied. * @user_data: (closure): the data to pass to callback function. @@ -1147,8 +1147,7 @@ g_data_input_stream_read_line_async (GDataInputStream *stream, * g_data_input_stream_read_until_async: * @stream: a given #GDataInputStream. * @stop_chars: characters to terminate the read. - * @io_priority: the I/O priority - * of the request. + * @io_priority: the [I/O priority][io-priority] of the request * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @callback: (scope async): callback to call when the request is satisfied. * @user_data: (closure): the data to pass to callback function. @@ -1199,12 +1198,12 @@ g_data_input_stream_read_until_async (GDataInputStream *stream, * string encoding in g_data_input_stream_read_line() applies here as * well. * - * Returns: (transfer full) (array zero-terminated=1) (element-type guint8): a - * NUL-terminated byte array with the line that was read in - * (without the newlines). Set @length to a #gsize to get the - * length of the read line. On an error, it will return %NULL and - * @error will be set. If there's no content to read, it will - * still return %NULL, but @error won't be set. + * Returns: (nullable) (transfer full) (array zero-terminated=1) (element-type guint8): + * a NUL-terminated byte array with the line that was read in + * (without the newlines). Set @length to a #gsize to get the length + * of the read line. On an error, it will return %NULL and @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 */ @@ -1229,12 +1228,12 @@ g_data_input_stream_read_line_finish (GDataInputStream *stream, * Finish an asynchronous call started by * g_data_input_stream_read_line_async(). * - * Returns: (transfer full): a string with the line that was read in - * (without the newlines). Set @length to a #gsize to get the length - * of the read line. On an error, it will return %NULL and @error - * will be set. For UTF-8 conversion errors, the set error domain is - * %G_CONVERT_ERROR. If there's no content to read, it will still - * return %NULL, but @error won't be set. + * Returns: (nullable) (transfer full): a string with the line that + * was read in (without the newlines). Set @length to a #gsize to + * get the length of the read line. On an error, it will return + * %NULL and @error will be set. For UTF-8 conversion errors, the set + * error domain is %G_CONVERT_ERROR. If there's no content to read, + * it will still return %NULL, but @error won't be set. * * Since: 2.30 */ @@ -1303,8 +1302,8 @@ g_data_input_stream_read_until_finish (GDataInputStream *stream, * occurrence of any of the stop characters. * * In contrast to g_data_input_stream_read_until(), this function - * does not consume the stop character. You have - * to use g_data_input_stream_read_byte() to get it before calling + * does not consume the stop character. You have to use + * g_data_input_stream_read_byte() to get it before calling * g_data_input_stream_read_upto() again. * * Note that @stop_chars may contain '\0' if @stop_chars_len is @@ -1387,8 +1386,7 @@ g_data_input_stream_read_upto (GDataInputStream *stream, * @stop_chars: characters to terminate the read * @stop_chars_len: length of @stop_chars. May be -1 if @stop_chars is * nul-terminated - * @io_priority: the I/O priority - * of the request. + * @io_priority: the [I/O priority][io-priority] of the request * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore * @callback: (scope async): callback to call when the request is satisfied * @user_data: (closure): the data to pass to callback function @@ -1397,8 +1395,8 @@ g_data_input_stream_read_upto (GDataInputStream *stream, * It is an error to have two outstanding calls to this function. * * In contrast to g_data_input_stream_read_until(), this function - * does not consume the stop character. You have - * to use g_data_input_stream_read_byte() to get it before calling + * does not consume the stop character. You have to use + * g_data_input_stream_read_byte() to get it before calling * g_data_input_stream_read_upto() again. * * Note that @stop_chars may contain '\0' if @stop_chars_len is @@ -1437,9 +1435,9 @@ g_data_input_stream_read_upto_async (GDataInputStream *stream, * Finish an asynchronous call started by * g_data_input_stream_read_upto_async(). * - * Note that this function does not consume the - * 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. + * Note that this function does not consume the 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. * * Returns: (transfer full): a string with the data that was read * before encountering any of the stop characters. Set @length to