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/gfile.h | |
| parent | b877c83cdcde2f7d26f9395d0b21230941cf190e (diff) | |
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/gfile.h')
| -rw-r--r-- | gio/gfile.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/gio/gfile.h b/gio/gfile.h index 5872b8d00..67dce7ab4 100644 --- a/gio/gfile.h +++ b/gio/gfile.h @@ -127,11 +127,16 @@ typedef void (*GFileProgressCallback) (goffset current_num_bytes, /** * GFileReadMoreCallback: - * @file_contents: - * @file_size: - * @callback_data: + * @file_contents: the data as currently read. + * @file_size: the size of the data currently read. + * @callback_data: data passed to the callback. * - * + * When loading the partial contents of a file with g_file_read_partial_contents(), + * it may become necessary to determine if any more data from the file should be loaded. + * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data + * should be read, or %FALSE otherwise. + * + * Returns: %TRUE if more data should be read back. %FALSE otherwise. **/ typedef gboolean (* GFileReadMoreCallback) (const char *file_contents, goffset file_size, @@ -180,7 +185,7 @@ typedef gboolean (* GFileReadMoreCallback) (const char *file_contents, * @set_attributes_from_info: Sets a #GFileAttribute with information from a #GFileInfo. * @set_attributes_async: Asynchronously sets a file's attributes. * @set_attributes_finish: Finishes setting a file's attributes asynchronously. - * @read: Reads a file asynchronously. + * @read_fn: Reads a file asynchronously. * @read_async: Asynchronously reads a file. * @read_finish: Finishes asynchronously reading a file. * @append_to: Writes to the end of a file. |