Commit 61582bd9 authored by Matthias Clasen's avatar Matthias Clasen

Another round of trivial doc fixes

svn path=/trunk/; revision=5970
parent 794b7d0b
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
/** /**
* SECTION:gappinfo * SECTION:gappinfo
* @short_description: Application information and launch contexts. * @short_description: Application information and launch contexts
* @stability: Unstable * @stability: Unstable
* *
* #GAppInfo and #GAppLaunchContext are used for describing and launching * #GAppInfo and #GAppLaunchContext are used for describing and launching
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
/** /**
* SECTION:gasynchelper * SECTION:gasynchelper
* @short_description: Asynchronous Helper Functions * @short_description: Asynchronous Helper Functions
* @see_also: #GAsyncReady. * @see_also: #GAsyncReady
* *
* Provides helper functions for asynchronous operations. * Provides helper functions for asynchronous operations.
* *
......
...@@ -31,7 +31,7 @@ ...@@ -31,7 +31,7 @@
/** /**
* SECTION:gbufferedinputstream * SECTION:gbufferedinputstream
* @short_description: Buffered Input Stream * @short_description: Buffered Input Stream
* @see_also: #GFilterInputStream, #GInputStream. * @see_also: #GFilterInputStream, #GInputStream
* *
* Buffered input stream implements #GFilterInputStream and provides * Buffered input stream implements #GFilterInputStream and provides
* for buffered reads. * for buffered reads.
......
...@@ -30,7 +30,7 @@ ...@@ -30,7 +30,7 @@
/** /**
* SECTION:gbufferedoutputstream * SECTION:gbufferedoutputstream
* @short_description: Buffered Output Stream * @short_description: Buffered Output Stream
* @see_also: #GFilterOutputStream, #GOutputStream. * @see_also: #GFilterOutputStream, #GOutputStream
* *
* Buffered output stream implements #GFilterOutputStream and provides * Buffered output stream implements #GFilterOutputStream and provides
* for buffered writes. * for buffered writes.
......
...@@ -27,8 +27,8 @@ ...@@ -27,8 +27,8 @@
/** /**
* SECTION:gdatainputstream * SECTION:gdatainputstream
* @short_description: Data Input Stream. * @short_description: Data Input Stream
* @see_also: #GInputStream. * @see_also: #GInputStream
* *
* Data input stream implements #GInputStream and includes functions for * Data input stream implements #GInputStream and includes functions for
* reading data directly from an input stream. * reading data directly from an input stream.
......
...@@ -27,8 +27,8 @@ ...@@ -27,8 +27,8 @@
/** /**
* SECTION:gdataoutputstream * SECTION:gdataoutputstream
* @short_description: Data Output Stream. * @short_description: Data Output Stream
* @see_also: #GOutputStream. * @see_also: #GOutputStream
* *
* Data output stream implements #GOutputStream and includes functions for * Data output stream implements #GOutputStream and includes functions for
* writing data directly to an output stream. * writing data directly to an output stream.
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
/** /**
* SECTION:gdirectorymonitor * SECTION:gdirectorymonitor
* @short_description: Directory Monitor * @short_description: Directory Monitor
* @see_also: #GFileMonitor. * @see_also: #GFileMonitor
* *
* Monitors a directory for changes. * Monitors a directory for changes.
* *
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
/** /**
* SECTION:gdrive * SECTION:gdrive
* @short_description: Virtual File System drive management. * @short_description: Virtual File System drive management
* @include: gio/gdrive.h * @include: gio/gdrive.h
* *
* #GDrive manages drive operations from GVFS, including volume mounting * #GDrive manages drive operations from GVFS, including volume mounting
......
...@@ -268,12 +268,15 @@ g_file_has_uri_scheme (GFile *file, ...@@ -268,12 +268,15 @@ g_file_has_uri_scheme (GFile *file,
* @file: input #GFile. * @file: input #GFile.
* *
* Gets the URI scheme for a #GFile. * Gets the URI scheme for a #GFile.
*
* Returns: string to the URI scheme for the given #GFile.
* RFC 3986 decodes the scheme as: * RFC 3986 decodes the scheme as:
* <programlisting>
* URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
* Common schemes include "file", "http", "svn", etc. The returned * </programlisting>
* string should be freed when no longer needed. * Common schemes include "file", "http", "svn", etc.
*
* Returns: a string containing the URI scheme for the given
* #GFile. The returned string should be freed with g_free()
* when no longer needed.
**/ **/
char * char *
g_file_get_uri_scheme (GFile *file) g_file_get_uri_scheme (GFile *file)
...@@ -294,9 +297,9 @@ g_file_get_uri_scheme (GFile *file) ...@@ -294,9 +297,9 @@ g_file_get_uri_scheme (GFile *file)
* *
* Gets the basename for a given #GFile. * Gets the basename for a given #GFile.
* *
* Returns: string containing the #GFile's base name, or %NULL if given * Returns: string containing the #GFile's base name, or %NULL
* #GFile is invalid. The returned string should be freed when no longer * if given #GFile is invalid. The returned string should be
* needed. * freed with g_free() when no longer needed.
**/ **/
char * char *
g_file_get_basename (GFile *file) g_file_get_basename (GFile *file)
...@@ -316,8 +319,9 @@ g_file_get_basename (GFile *file) ...@@ -316,8 +319,9 @@ g_file_get_basename (GFile *file)
* *
* Gets the current path within a #GFile. * Gets the current path within a #GFile.
* *
* Returns: string containing the #GFile's path, or %NULL if given #GFile is * Returns: string containing the #GFile's path, or %NULL if
* invalid. The returned string should be freed when no longer needed. * given #GFile is invalid. The returned string should be
* freed with g_free() when no longer needed.
**/ **/
char * char *
g_file_get_path (GFile *file) g_file_get_path (GFile *file)
...@@ -337,9 +341,9 @@ g_file_get_path (GFile *file) ...@@ -337,9 +341,9 @@ g_file_get_path (GFile *file)
* *
* Gets a URI for the path within a #GFile. * Gets a URI for the path within a #GFile.
* *
* Returns: string to the #GFile's Universal Resource Identifier (URI), * Returns: a string containing the #GFile's URI or %NULL
* or %NULL if given #GFile is invalid. The returned string should be freed * if given #GFile is invalid. The returned string should
* when no longer needed. * be freed with g_free() when no longer needed.
**/ **/
char * char *
g_file_get_uri (GFile *file) g_file_get_uri (GFile *file)
...@@ -359,8 +363,9 @@ g_file_get_uri (GFile *file) ...@@ -359,8 +363,9 @@ g_file_get_uri (GFile *file)
* *
* Gets the parsed name for the #GFile. * Gets the parsed name for the #GFile.
* *
* Returns: string to the #GFile's parsed name, or %NULL if given * Returns: a string containing the #GFile's parsed name,
* #GFile is invalid. The returned string should be freed when no longer needed. * or %NULL if given #GFile is invalid. The returned
* string should be freed with g_free() when no longer needed.
**/ **/
char * char *
g_file_get_parse_name (GFile *file) g_file_get_parse_name (GFile *file)
...@@ -379,11 +384,11 @@ g_file_get_parse_name (GFile *file) ...@@ -379,11 +384,11 @@ g_file_get_parse_name (GFile *file)
* @file: input #GFile. * @file: input #GFile.
* *
* Duplicates a #GFile handle. This operation does not duplicate * Duplicates a #GFile handle. This operation does not duplicate
* the actual file or directory represented by the #GFile; see g_file_copy() * the actual file or directory represented by the #GFile; see
* if attempting to copy a file. * g_file_copy() if attempting to copy a file.
* *
* Returns: #GFile that is a duplicate of the given #GFile, * Returns: #GFile that is a duplicate of the given #GFile,
* or %NULL if given #GFile is invalid. * or %NULL if given #GFile is invalid.
**/ **/
GFile * GFile *
g_file_dup (GFile *file) g_file_dup (GFile *file)
...@@ -401,13 +406,12 @@ g_file_dup (GFile *file) ...@@ -401,13 +406,12 @@ g_file_dup (GFile *file)
* g_file_hash: * g_file_hash:
* @file: #gconstpointer to a #GFile. * @file: #gconstpointer to a #GFile.
* *
* Creates a hash of a #GFile. * Creates a hash value for a #GFile.
* *
* Returns: 0 if @file is not a valid #GFile, otherwise a * Returns: 0 if @file is not a valid #GFile, otherwise an
* guint containing a hash of the #GFile. This function * integer that can be used as hash value for the #GFile.
* is intended for easily hashing a #GFile to add to a * This function is intended for easily hashing a #GFile to
* #GHashTable or similar data structure. * add to a #GHashTable or similar data structure.
*
**/ **/
guint guint
g_file_hash (gconstpointer file) g_file_hash (gconstpointer file)
...@@ -555,8 +559,9 @@ g_file_contains_file (GFile *parent, ...@@ -555,8 +559,9 @@ g_file_contains_file (GFile *parent,
* *
* Gets the path for @descendant relative to @parent. * Gets the path for @descendant relative to @parent.
* *
* Returns: string with the relative path from @descendant to @parent. * Returns: string with the relative path from @descendant
* The returned string should be freed when no longer needed. * to @parent. The returned string should be freed with
* g_free() when no longer needed.
**/ **/
char * char *
g_file_get_relative_path (GFile *parent, g_file_get_relative_path (GFile *parent,
...@@ -582,8 +587,8 @@ g_file_get_relative_path (GFile *parent, ...@@ -582,8 +587,8 @@ g_file_get_relative_path (GFile *parent,
* *
* Resolves a relative path for @file to an absolute path. * Resolves a relative path for @file to an absolute path.
* *
* Returns: #GFile to the resolved path. %NULL if @relative_path is NULL. * Returns: #GFile to the resolved path. %NULL if @relative_path
* or if @file is invalid. * is %NULL or if @file is invalid.
**/ **/
GFile * GFile *
g_file_resolve_relative_path (GFile *file, g_file_resolve_relative_path (GFile *file,
...@@ -608,7 +613,8 @@ g_file_resolve_relative_path (GFile *file, ...@@ -608,7 +613,8 @@ g_file_resolve_relative_path (GFile *file,
* @error: #GError for error reporting. * @error: #GError for error reporting.
* *
* Gets a #GFileEnumerator for the children of @file that match @attributes, * Gets a #GFileEnumerator for the children of @file that match @attributes,
* where attributes is a #GFileAttributeInfo query string (e.g. "std:type", "std:*"). * where attributes is a #GFileAttributeInfo query string (e.g. "std:type",
* "std:*").
* *
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
...@@ -619,7 +625,7 @@ g_file_resolve_relative_path (GFile *file, ...@@ -619,7 +625,7 @@ g_file_resolve_relative_path (GFile *file,
* be set in @error. * be set in @error.
* *
* Returns: A #GFileEnumerator if successful. %NULL if cancelled or if #GFile's * Returns: A #GFileEnumerator if successful. %NULL if cancelled or if #GFile's
* backend doesn't support #GFileEnumerator. * backend doesn't support #GFileEnumerator.
**/ **/
GFileEnumerator * GFileEnumerator *
g_file_enumerate_children (GFile *file, g_file_enumerate_children (GFile *file,
...@@ -660,12 +666,12 @@ g_file_enumerate_children (GFile *file, ...@@ -660,12 +666,12 @@ g_file_enumerate_children (GFile *file,
* @callback: a #GAsyncReadyCallback. * @callback: a #GAsyncReadyCallback.
* @user_data: a #gpointer. * @user_data: a #gpointer.
* *
* Asynchronously gets a #GFileEnumerator for the children of @file that match @attributes, * Asynchronously gets a #GFileEnumerator for the children of @file that
* where attributes is a #GFileAttributeInfo query string (e.g. "std:type", "std:*"). For the * match @attributes, where attributes is a #GFileAttributeInfo query
* synchronous version of this function, see g_file_enumerate_children(). * string (e.g. "std:type", "std:*"). For the synchronous version of this
* function, see g_file_enumerate_children().
* *
* To finish this asynchronous operation, see g_file_enumerate_children_finish(). * To finish this asynchronous operation, see g_file_enumerate_children_finish().
*
**/ **/
void void
g_file_enumerate_children_async (GFile *file, g_file_enumerate_children_async (GFile *file,
...@@ -696,10 +702,11 @@ g_file_enumerate_children_async (GFile *file, ...@@ -696,10 +702,11 @@ g_file_enumerate_children_async (GFile *file,
* @res: a #GAsyncResult. * @res: a #GAsyncResult.
* @error: a #GError. * @error: a #GError.
* *
* If @cancellable was not %NULL when g_file_enumerate_children_async() was called, * If @cancellable was not %NULL when g_file_enumerate_children_async()
* then the operation could have been cancelled by triggering the cancellable object * was called, then the operation could have been cancelled by triggering
* from another thread. If the operation was cancelled, the @error will be set to * the cancellable object from another thread. If the operation was cancelled,
* %G_IO_ERROR_CANCELLED and this function will return %NULL. * the @error will be set to %G_IO_ERROR_CANCELLED and this function will
* return %NULL.
* *
* If the #GFileIface for the given @file does not support enumerating files, * If the #GFileIface for the given @file does not support enumerating files,
* then %NULL will be returned and the error %G_IO_ERROR_NOT_SUPPORTED will * then %NULL will be returned and the error %G_IO_ERROR_NOT_SUPPORTED will
...@@ -741,9 +748,9 @@ g_file_enumerate_children_finish (GFile *file, ...@@ -741,9 +748,9 @@ g_file_enumerate_children_finish (GFile *file,
* 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.
* *
* If the #GFileIface for the given @file does not support querying file information, * If the #GFileIface for the given @file does not support querying file
* then %NULL will be returned and the error %G_IO_ERROR_NOT_SUPPORTED will * information, then %NULL will be returned and the error
* be set in @error. * %G_IO_ERROR_NOT_SUPPORTED will be set in @error.
* *
* Returns: a #GFileInfo for the given @file, or %NULL on error. * Returns: a #GFileInfo for the given @file, or %NULL on error.
**/ **/
...@@ -779,7 +786,7 @@ g_file_query_info (GFile *file, ...@@ -779,7 +786,7 @@ g_file_query_info (GFile *file,
* @file: input #GFile. * @file: input #GFile.
* @attributes: a string containing a #GFileAttributeInfo query. * @attributes: a string containing a #GFileAttributeInfo query.
* @flags: a set of #GFileQueryInfoFlags. * @flags: a set of #GFileQueryInfoFlags.
* @io_priority: the io priority of the request. the io priority of the request. * @io_priority: the io priority of the request.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback. * @callback: a #GAsyncReadyCallback.
* @user_data: a #gpointer. * @user_data: a #gpointer.
...@@ -789,7 +796,6 @@ g_file_query_info (GFile *file, ...@@ -789,7 +796,6 @@ g_file_query_info (GFile *file,
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
* *
* To finish this asynchronous operation, see g_file_query_info_finish(). * To finish this asynchronous operation, see g_file_query_info_finish().
*
**/ **/
void void
g_file_query_info_async (GFile *file, g_file_query_info_async (GFile *file,
...@@ -823,13 +829,13 @@ g_file_query_info_async (GFile *file, ...@@ -823,13 +829,13 @@ g_file_query_info_async (GFile *file,
* Finishes an asynchronous file info query. * Finishes an asynchronous file info query.
* *
* If @cancellable was not %NULL when g_file_query_info_async() was called, * If @cancellable was not %NULL when g_file_query_info_async() was called,
* then the operation could have been cancelled by triggering the cancellable object * then the operation could have been cancelled by triggering the cancellable
* from another thread. If the operation was cancelled, the @error will be set to * object from another thread. If the operation was cancelled, the @error will
* %G_IO_ERROR_CANCELLED and this function will return %NULL. * be set to %G_IO_ERROR_CANCELLED and this function will return %NULL.
* *
* If the #GFileIface for the given @file does not support querying file information, * If the #GFileIface for the given @file does not support querying file
* then %NULL will be returned and the error %G_IO_ERROR_NOT_SUPPORTED will * information, then %NULL will be returned and the error
* be set in @error. * %G_IO_ERROR_NOT_SUPPORTED will be set in @error.
* *
* Returns: #GFileInfo for given @file or %NULL on error. * Returns: #GFileInfo for given @file or %NULL on error.
**/ **/
...@@ -1131,7 +1137,6 @@ g_file_replace (GFile *file, ...@@ -1131,7 +1137,6 @@ g_file_replace (GFile *file,
* *
* Asynchronously reads @file. For the synchronous version of this function, * Asynchronously reads @file. For the synchronous version of this function,
* see g_file_read(). * see g_file_read().
*
**/ **/
void void
g_file_read_async (GFile *file, g_file_read_async (GFile *file,
...@@ -1207,7 +1212,6 @@ g_file_read_finish (GFile *file, ...@@ -1207,7 +1212,6 @@ g_file_read_finish (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_append_to_async (GFile *file, g_file_append_to_async (GFile *file,
...@@ -1276,7 +1280,6 @@ g_file_append_to_finish (GFile *file, ...@@ -1276,7 +1280,6 @@ g_file_append_to_finish (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_create_async (GFile *file, g_file_create_async (GFile *file,
...@@ -1348,7 +1351,6 @@ g_file_create_finish (GFile *file, ...@@ -1348,7 +1351,6 @@ g_file_create_finish (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_replace_async (GFile *file, g_file_replace_async (GFile *file,
...@@ -1960,6 +1962,7 @@ g_file_copy (GFile *source, ...@@ -1960,6 +1962,7 @@ g_file_copy (GFile *source,
* </tbody> * </tbody>
* </tgroup> * </tgroup>
* </table> * </table>
*
* Returns: %TRUE on successful move, %FALSE otherwise. * Returns: %TRUE on successful move, %FALSE otherwise.
**/ **/
gboolean gboolean
...@@ -2236,7 +2239,6 @@ g_file_set_display_name (GFile *file, ...@@ -2236,7 +2239,6 @@ g_file_set_display_name (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_set_display_name_async (GFile *file, g_file_set_display_name_async (GFile *file,
...@@ -2353,8 +2355,8 @@ g_file_query_settable_attributes (GFile *file, ...@@ -2353,8 +2355,8 @@ g_file_query_settable_attributes (GFile *file,
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
* *
* Returns: a #GFileAttributeInfoList of attribute namespaces * Returns: a #GFileAttributeInfoList of attribute namespaces
* where the user can create their own attribute names, such * where the user can create their own attribute names, such
* as extended attributes. * as extended attributes.
**/ **/
GFileAttributeInfoList * GFileAttributeInfoList *
g_file_query_writable_namespaces (GFile *file, g_file_query_writable_namespaces (GFile *file,
...@@ -2448,16 +2450,17 @@ g_file_set_attribute (GFile *file, ...@@ -2448,16 +2450,17 @@ g_file_set_attribute (GFile *file,
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @error: a #GError, or %NULL * @error: a #GError, or %NULL
* *
* Tries to set all attributes in the #GFileInfo on the target values, not stopping * Tries to set all attributes in the #GFileInfo on the target values,
* on the first error. * not stopping on the first error.
* *
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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: %TRUE if there was any error, and @error will be set to * Returns: %TRUE if there was any error, and @error will be set to
* the first error. Error on particular fields are flagged by setting the * the first error. Error on particular fields are flagged by setting
* "status" field in the attribute value to %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING. * the "status" field in the attribute value to
* %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING.
**/ **/
gboolean gboolean
g_file_set_attributes_from_info (GFile *file, g_file_set_attributes_from_info (GFile *file,
...@@ -2537,7 +2540,6 @@ g_file_real_set_attributes_from_info (GFile *file, ...@@ -2537,7 +2540,6 @@ g_file_real_set_attributes_from_info (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_set_attributes_async (GFile *file, g_file_set_attributes_async (GFile *file,
...@@ -2802,7 +2804,6 @@ g_file_set_attribute_int64 (GFile *file, ...@@ -2802,7 +2804,6 @@ g_file_set_attribute_int64 (GFile *file,
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
* *
* Mounts a mountable file using @mount_operation, if possible. * Mounts a mountable file using @mount_operation, if possible.
*
**/ **/
void void
g_file_mount_mountable (GFile *file, g_file_mount_mountable (GFile *file,
...@@ -2875,7 +2876,6 @@ g_file_mount_mountable_finish (GFile *file, ...@@ -2875,7 +2876,6 @@ g_file_mount_mountable_finish (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_unmount_mountable (GFile *file, g_file_unmount_mountable (GFile *file,
...@@ -2950,7 +2950,6 @@ g_file_unmount_mountable_finish (GFile *file, ...@@ -2950,7 +2950,6 @@ g_file_unmount_mountable_finish (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_eject_mountable (GFile *file, g_file_eject_mountable (GFile *file,
...@@ -3668,9 +3667,9 @@ g_file_real_set_attributes_finish (GFile *file, ...@@ -3668,9 +3667,9 @@ g_file_real_set_attributes_finish (GFile *file,
* g_file_new_for_path: * g_file_new_for_path:
* @path: a string containing a relative or absolute path. * @path: a string containing a relative or absolute path.
* *
* Constructs a #GFile for given @path. This operation never * Constructs a #GFile for a given path. This operation never
* fails, but the returned object might not support any I/O * fails, but the returned object might not support any I/O
* operation if the @path is malformed. * operation if @path is malformed.
* *
* Returns: a new #GFile for the given @path. * Returns: a new #GFile for the given @path.
**/ **/
...@@ -3687,9 +3686,10 @@ g_file_new_for_path (const char *path) ...@@ -3687,9 +3686,10 @@ g_file_new_for_path (const char *path)
* g_file_new_for_uri: * g_file_new_for_uri:
* @uri: a string containing a URI. * @uri: a string containing a URI.
* *
* This operation never fails, but the returned object * Constructs a #GFile for a given URI. This operation never
* might not support any I/O operation if the @uri * fails, but the returned object might not support any I/O
* is malformed or if the uri type is not supported. * operation if @uri is malformed or if the uri type is
* not supported.
* *
* Returns: a #GFile for the given @uri. * Returns: a #GFile for the given @uri.
**/ **/
...@@ -3796,7 +3796,6 @@ g_file_new_for_commandline_arg (const char *arg) ...@@ -3796,7 +3796,6 @@ g_file_new_for_commandline_arg (const char *arg)
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_mount_for_location (GFile *location, g_mount_for_location (GFile *location,
...@@ -4133,7 +4132,6 @@ load_contents_open_callback (GObject *obj, ...@@ -4133,7 +4132,6 @@ load_contents_open_callback (GObject *obj,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_load_partial_contents_async (GFile *file, g_file_load_partial_contents_async (GFile *file,
...@@ -4244,7 +4242,6 @@ g_file_load_partial_contents_finish (GFile *file, ...@@ -4244,7 +4242,6 @@ g_file_load_partial_contents_finish (GFile *file,
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* 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.
*
**/ **/
void void
g_file_load_contents_async (GFile *file, g_file_load_contents_async (GFile *file,
...@@ -4521,7 +4518,6 @@ replace_contents_open_callback (GObject *obj, ...@@ -4521,7 +4518,6 @@ replace_contents_open_callback (GObject *obj,
* *
* If @make_backup is %TRUE, this function will attempt to * If @make_backup is %TRUE, this function will attempt to
* make a backup of @file. * make a backup of @file.
*
**/ **/
void void
g_file_replace_contents_async (GFile *file, g_file_replace_contents_async (GFile *file,
......
...@@ -39,7 +39,7 @@ G_BEGIN_DECLS ...@@ -39,7 +39,7 @@ G_BEGIN_DECLS
/** /**
* GFileQueryInfoFlags: * GFileQueryInfoFlags:
* @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: * @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: Don't follow symlinks.
* *
* Flags used when querying a #GFileInfo. * Flags used when querying a #GFileInfo.
*/ */
...@@ -49,8 +49,9 @@ typedef enum { ...@@ -49,8 +49,9 @@ typedef enum {
/** /**
* GFileCreateFlags: * GFileCreateFlags:
* @G_FILE_CREATE_FLAGS_NONE: * @G_FILE_CREATE_FLAGS_NONE: No flags set.
* @G_FILE_CREATE_FLAGS_PRIVATE: * @G_FILE_CREATE_FLAGS_PRIVATE: Create a file that can only be
* accessed by the current user.
* *
* Flags used when an operation may create a file. * Flags used when an operation may create a file.
*/ */
...@@ -62,7 +63,7 @@ typedef enum { ...@@ -62,7 +63,7 @@ typedef enum {
/** /**
* GFileCopyFlags: * GFileCopyFlags:
* @G_FILE_COPY_OVERWRITE: Overwrite any existing files * @G_FILE_COPY_OVERWRITE: Overwrite any existing files
* @G_FILE_COPY_BACKUP: Make a backup of any existing files. * @G_FILE_COPY_BACKUP: Make a backup of any existing files. TODO: explain backup naming scheme.
* @G_FILE_COPY_NOFOLLOW_SYMLINKS: Don't follow symlinks. * @G_FILE_COPY_NOFOLLOW_SYMLINKS: Don't follow symlinks.
* @G_FILE_COPY_ALL_METADATA: Copy all file metadata (see #GFileInfo). * @G_FILE_COPY_ALL_METADATA: Copy all file metadata (see #GFileInfo).
* *
......
...@@ -30,8 +30,8 @@ ...@@ -30,8 +30,8 @@
/** /**
* SECTION:gfileattribute * SECTION:gfileattribute
* @short_description: Key-Value Paired File Attributes. * @short_description: Key-Value Paired File Attributes
* @see_also: #GFile, #GFileInfo. * @see_also: #GFile, #GFileInfo
* *
* File attributes in GIO consist of a list of key-value pairs. * File attributes in GIO consist of a list of key-value pairs.
* *
......
...@@ -29,7 +29,7 @@ ...@@ -29,7 +29,7 @@
/** /**
* SECTION:gfileenumerator * SECTION:gfileenumerator
* @short_description: Enumerated Files Routines. * @short_description: Enumerated Files Routines
* *
* *
**/ **/
......
...@@ -27,8 +27,8 @@ ...@@ -27,8 +27,8 @@
/** /**
* SECTION:gfileicon * SECTION:gfileicon
* @short_description: Icons for given files. * @short_description: Icons for given files
* @see_also: #GIcon, #GLoadableIcon. * @see_also: #GIcon, #GLoadableIcon
* @include: gio/gfileicon.h * @include: gio/gfileicon.h
* *
* #GFileIcon gets the default icon for a #GFile. * #GFileIcon gets the default icon for a #GFile.
......
...@@ -22,8 +22,8 @@ ...@@ -22,8 +22,8 @@
/** /**
* SECTION:gfileinfo * SECTION:gfileinfo
* @short_description: File Information and Attributes. * @short_description: File Information and Attributes
* @see_also: #GFile. * @see_also: #GFile
* *
* Functionality for manipulating basic metadata for files. #GFileInfo * Functionality for manipulating basic metadata for files. #GFileInfo
* implements methods for getting information that all files should * implements methods for getting information that all files should
......
...@@ -31,7 +31,7 @@ ...@@ -31,7 +31,7 @@
/** /**
* SECTION:gfileinputstream * SECTION:gfileinputstream
* @short_description: file input streaming operations * @short_description: file input streaming operations
* @see_also: #GInputStream, #GDataInputStream, #GSeekable.