From 61582bd91cba508362d0e28db4d6e3f307b27b48 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 28 Nov 2007 06:43:33 +0000 Subject: [PATCH] Another round of trivial doc fixes svn path=/trunk/; revision=5970 --- gio/gappinfo.c | 2 +- gio/gasynchelper.c | 2 +- gio/gbufferedinputstream.c | 2 +- gio/gbufferedoutputstream.c | 2 +- gio/gdatainputstream.c | 4 +- gio/gdataoutputstream.c | 4 +- gio/gdirectorymonitor.c | 2 +- gio/gdrive.c | 2 +- gio/gfile.c | 140 +++++++++++++++++++++----------------------- gio/gfile.h | 9 +-- gio/gfileattribute.c | 4 +- gio/gfileenumerator.c | 2 +- gio/gfileicon.c | 4 +- gio/gfileinfo.c | 4 +- gio/gfileinputstream.c | 2 +- gio/gfilenamecompleter.c | 2 +- gio/gfileoutputstream.c | 2 +- gio/gfilterinputstream.c | 2 +- gio/gioerror.c | 2 +- gio/gmemoryinputstream.c | 2 +- gio/gmemoryoutputstream.c | 2 +- gio/gmountoperation.c | 2 +- gio/gseekable.c | 4 +- gio/gsimpleasyncresult.c | 4 +- gio/gthemedicon.c | 2 +- gio/gunixinputstream.c | 2 +- gio/gunixoutputstream.c | 2 +- 27 files changed, 105 insertions(+), 108 deletions(-) diff --git a/gio/gappinfo.c b/gio/gappinfo.c index 96781ef..7dfd162 100644 --- a/gio/gappinfo.c +++ b/gio/gappinfo.c @@ -27,7 +27,7 @@ /** * SECTION:gappinfo - * @short_description: Application information and launch contexts. + * @short_description: Application information and launch contexts * @stability: Unstable * * #GAppInfo and #GAppLaunchContext are used for describing and launching diff --git a/gio/gasynchelper.c b/gio/gasynchelper.c index 98bce1b..620885d 100644 --- a/gio/gasynchelper.c +++ b/gio/gasynchelper.c @@ -27,7 +27,7 @@ /** * SECTION:gasynchelper * @short_description: Asynchronous Helper Functions - * @see_also: #GAsyncReady. + * @see_also: #GAsyncReady * * Provides helper functions for asynchronous operations. * diff --git a/gio/gbufferedinputstream.c b/gio/gbufferedinputstream.c index 1c7d377..bbc9a4c 100644 --- a/gio/gbufferedinputstream.c +++ b/gio/gbufferedinputstream.c @@ -31,7 +31,7 @@ /** * SECTION:gbufferedinputstream * @short_description: Buffered Input Stream - * @see_also: #GFilterInputStream, #GInputStream. + * @see_also: #GFilterInputStream, #GInputStream * * Buffered input stream implements #GFilterInputStream and provides * for buffered reads. diff --git a/gio/gbufferedoutputstream.c b/gio/gbufferedoutputstream.c index c924425..309de9e 100644 --- a/gio/gbufferedoutputstream.c +++ b/gio/gbufferedoutputstream.c @@ -30,7 +30,7 @@ /** * SECTION:gbufferedoutputstream * @short_description: Buffered Output Stream - * @see_also: #GFilterOutputStream, #GOutputStream. + * @see_also: #GFilterOutputStream, #GOutputStream * * Buffered output stream implements #GFilterOutputStream and provides * for buffered writes. diff --git a/gio/gdatainputstream.c b/gio/gdatainputstream.c index 7890d29..095428a 100644 --- a/gio/gdatainputstream.c +++ b/gio/gdatainputstream.c @@ -27,8 +27,8 @@ /** * SECTION:gdatainputstream - * @short_description: Data Input Stream. - * @see_also: #GInputStream. + * @short_description: Data Input Stream + * @see_also: #GInputStream * * Data input stream implements #GInputStream and includes functions for * reading data directly from an input stream. diff --git a/gio/gdataoutputstream.c b/gio/gdataoutputstream.c index d8b8f95..5f6bd82 100644 --- a/gio/gdataoutputstream.c +++ b/gio/gdataoutputstream.c @@ -27,8 +27,8 @@ /** * SECTION:gdataoutputstream - * @short_description: Data Output Stream. - * @see_also: #GOutputStream. + * @short_description: Data Output Stream + * @see_also: #GOutputStream * * Data output stream implements #GOutputStream and includes functions for * writing data directly to an output stream. diff --git a/gio/gdirectorymonitor.c b/gio/gdirectorymonitor.c index c0517c6..489a7ad 100644 --- a/gio/gdirectorymonitor.c +++ b/gio/gdirectorymonitor.c @@ -32,7 +32,7 @@ /** * SECTION:gdirectorymonitor * @short_description: Directory Monitor - * @see_also: #GFileMonitor. + * @see_also: #GFileMonitor * * Monitors a directory for changes. * diff --git a/gio/gdrive.c b/gio/gdrive.c index f902e04..6303f33 100644 --- a/gio/gdrive.c +++ b/gio/gdrive.c @@ -27,7 +27,7 @@ /** * SECTION:gdrive - * @short_description: Virtual File System drive management. + * @short_description: Virtual File System drive management * @include: gio/gdrive.h * * #GDrive manages drive operations from GVFS, including volume mounting diff --git a/gio/gfile.c b/gio/gfile.c index f5f8d5d..a28671c 100644 --- a/gio/gfile.c +++ b/gio/gfile.c @@ -268,12 +268,15 @@ g_file_has_uri_scheme (GFile *file, * @file: input #GFile. * * Gets the URI scheme for a #GFile. - * - * Returns: string to the URI scheme for the given #GFile. * RFC 3986 decodes the scheme as: + * * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] - * Common schemes include "file", "http", "svn", etc. The returned - * 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 * 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. * - * Returns: string containing the #GFile's base name, or %NULL if given - * #GFile is invalid. The returned string should be freed when no longer - * needed. + * Returns: string containing the #GFile's base name, or %NULL + * if given #GFile is invalid. The returned string should be + * freed with g_free() when no longer needed. **/ char * g_file_get_basename (GFile *file) @@ -316,8 +319,9 @@ g_file_get_basename (GFile *file) * * Gets the current path within a #GFile. * - * Returns: string containing the #GFile's path, or %NULL if given #GFile is - * invalid. The returned string should be freed when no longer needed. + * Returns: string containing the #GFile's path, or %NULL if + * given #GFile is invalid. The returned string should be + * freed with g_free() when no longer needed. **/ char * 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. * - * Returns: string to the #GFile's Universal Resource Identifier (URI), - * or %NULL if given #GFile is invalid. The returned string should be freed - * when no longer needed. + * Returns: a string containing the #GFile's URI or %NULL + * if given #GFile is invalid. The returned string should + * be freed with g_free() when no longer needed. **/ char * g_file_get_uri (GFile *file) @@ -359,8 +363,9 @@ g_file_get_uri (GFile *file) * * Gets the parsed name for the #GFile. * - * Returns: string to the #GFile's parsed name, or %NULL if given - * #GFile is invalid. The returned string should be freed when no longer needed. + * Returns: a string containing the #GFile's parsed name, + * or %NULL if given #GFile is invalid. The returned + * string should be freed with g_free() when no longer needed. **/ char * g_file_get_parse_name (GFile *file) @@ -379,11 +384,11 @@ g_file_get_parse_name (GFile *file) * @file: input #GFile. * * Duplicates a #GFile handle. This operation does not duplicate - * the actual file or directory represented by the #GFile; see g_file_copy() - * if attempting to copy a file. + * the actual file or directory represented by the #GFile; see + * g_file_copy() if attempting to copy a file. * * 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 * g_file_dup (GFile *file) @@ -401,13 +406,12 @@ g_file_dup (GFile *file) * g_file_hash: * @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 - * guint containing a hash of the #GFile. This function - * is intended for easily hashing a #GFile to add to a - * #GHashTable or similar data structure. - * + * Returns: 0 if @file is not a valid #GFile, otherwise an + * integer that can be used as hash value for the #GFile. + * This function is intended for easily hashing a #GFile to + * add to a #GHashTable or similar data structure. **/ guint g_file_hash (gconstpointer file) @@ -555,8 +559,9 @@ g_file_contains_file (GFile *parent, * * Gets the path for @descendant relative to @parent. * - * Returns: string with the relative path from @descendant to @parent. - * The returned string should be freed when no longer needed. + * Returns: string with the relative path from @descendant + * to @parent. The returned string should be freed with + * g_free() when no longer needed. **/ char * 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. * - * Returns: #GFile to the resolved path. %NULL if @relative_path is NULL. - * or if @file is invalid. + * Returns: #GFile to the resolved path. %NULL if @relative_path + * is %NULL or if @file is invalid. **/ GFile * g_file_resolve_relative_path (GFile *file, @@ -608,7 +613,8 @@ g_file_resolve_relative_path (GFile *file, * @error: #GError for error reporting. * * 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 * triggering the cancellable object from another thread. If the operation @@ -619,7 +625,7 @@ g_file_resolve_relative_path (GFile *file, * be set in @error. * * Returns: A #GFileEnumerator if successful. %NULL if cancelled or if #GFile's - * backend doesn't support #GFileEnumerator. + * backend doesn't support #GFileEnumerator. **/ GFileEnumerator * g_file_enumerate_children (GFile *file, @@ -660,12 +666,12 @@ g_file_enumerate_children (GFile *file, * @callback: a #GAsyncReadyCallback. * @user_data: a #gpointer. * - * Asynchronously gets a #GFileEnumerator for the children of @file that match @attributes, - * where attributes is a #GFileAttributeInfo query string (e.g. "std:type", "std:*"). For the - * synchronous version of this function, see g_file_enumerate_children(). + * Asynchronously gets a #GFileEnumerator for the children of @file that + * match @attributes, where attributes is a #GFileAttributeInfo query + * 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(). - * **/ void g_file_enumerate_children_async (GFile *file, @@ -696,10 +702,11 @@ g_file_enumerate_children_async (GFile *file, * @res: a #GAsyncResult. * @error: a #GError. * - * If @cancellable was not %NULL when g_file_enumerate_children_async() was called, - * then the operation could have been cancelled by triggering the cancellable object - * from another thread. If the operation was cancelled, the @error will be set to - * %G_IO_ERROR_CANCELLED and this function will return %NULL. + * If @cancellable was not %NULL when g_file_enumerate_children_async() + * was called, then the operation could have been cancelled by triggering + * the cancellable object from another thread. If the operation was cancelled, + * 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, * 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, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * If the #GFileIface for the given @file does not support querying file information, - * then %NULL will be returned and the error %G_IO_ERROR_NOT_SUPPORTED will - * be set in @error. + * If the #GFileIface for the given @file does not support querying file + * information, then %NULL will be returned and the error + * %G_IO_ERROR_NOT_SUPPORTED will be set in @error. * * Returns: a #GFileInfo for the given @file, or %NULL on error. **/ @@ -779,7 +786,7 @@ g_file_query_info (GFile *file, * @file: input #GFile. * @attributes: a string containing a #GFileAttributeInfo query. * @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. * @callback: a #GAsyncReadyCallback. * @user_data: a #gpointer. @@ -789,7 +796,6 @@ g_file_query_info (GFile *file, * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * To finish this asynchronous operation, see g_file_query_info_finish(). - * **/ void g_file_query_info_async (GFile *file, @@ -823,13 +829,13 @@ g_file_query_info_async (GFile *file, * Finishes an asynchronous file info query. * * 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 - * from another thread. If the operation was cancelled, the @error will be set to - * %G_IO_ERROR_CANCELLED and this function will return %NULL. + * then the operation could have been cancelled by triggering the cancellable + * object from another thread. If the operation was cancelled, 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 querying file information, - * then %NULL will be returned and the error %G_IO_ERROR_NOT_SUPPORTED will - * be set in @error. + * If the #GFileIface for the given @file does not support querying file + * information, then %NULL will be returned and the error + * %G_IO_ERROR_NOT_SUPPORTED will be set in @error. * * Returns: #GFileInfo for given @file or %NULL on error. **/ @@ -1131,7 +1137,6 @@ g_file_replace (GFile *file, * * Asynchronously reads @file. For the synchronous version of this function, * see g_file_read(). - * **/ void g_file_read_async (GFile *file, @@ -1207,7 +1212,6 @@ g_file_read_finish (GFile *file, * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_append_to_async (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 * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_create_async (GFile *file, @@ -1348,7 +1351,6 @@ g_file_create_finish (GFile *file, * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_replace_async (GFile *file, @@ -1960,6 +1962,7 @@ g_file_copy (GFile *source, * * * + * * Returns: %TRUE on successful move, %FALSE otherwise. **/ gboolean @@ -2236,7 +2239,6 @@ g_file_set_display_name (GFile *file, * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_set_display_name_async (GFile *file, @@ -2353,8 +2355,8 @@ g_file_query_settable_attributes (GFile *file, * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * Returns: a #GFileAttributeInfoList of attribute namespaces - * where the user can create their own attribute names, such - * as extended attributes. + * where the user can create their own attribute names, such + * as extended attributes. **/ GFileAttributeInfoList * g_file_query_writable_namespaces (GFile *file, @@ -2448,16 +2450,17 @@ g_file_set_attribute (GFile *file, * @cancellable: optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * - * Tries to set all attributes in the #GFileInfo on the target values, not stopping - * on the first error. + * Tries to set all attributes in the #GFileInfo on the target values, + * not stopping on the first error. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * 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 - * "status" field in the attribute value to %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING. + * the first error. Error on particular fields are flagged by setting + * the "status" field in the attribute value to + * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING. **/ gboolean g_file_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 * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_set_attributes_async (GFile *file, @@ -2802,7 +2804,6 @@ g_file_set_attribute_int64 (GFile *file, * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * Mounts a mountable file using @mount_operation, if possible. - * **/ void g_file_mount_mountable (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 * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_unmount_mountable (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 * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_eject_mountable (GFile *file, @@ -3668,9 +3667,9 @@ g_file_real_set_attributes_finish (GFile *file, * g_file_new_for_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 - * operation if the @path is malformed. + * operation if @path is malformed. * * Returns: a new #GFile for the given @path. **/ @@ -3687,9 +3686,10 @@ g_file_new_for_path (const char *path) * g_file_new_for_uri: * @uri: a string containing a URI. * - * This operation never fails, but the returned object - * might not support any I/O operation if the @uri - * is malformed or if the uri type is not supported. + * Constructs a #GFile for a given URI. This operation never + * fails, but the returned object might not support any I/O + * operation if @uri is malformed or if the uri type is + * not supported. * * Returns: a #GFile for the given @uri. **/ @@ -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 * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_mount_for_location (GFile *location, @@ -4133,7 +4132,6 @@ load_contents_open_callback (GObject *obj, * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_load_partial_contents_async (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 * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * **/ void g_file_load_contents_async (GFile *file, @@ -4521,7 +4518,6 @@ replace_contents_open_callback (GObject *obj, * * If @make_backup is %TRUE, this function will attempt to * make a backup of @file. - * **/ void g_file_replace_contents_async (GFile *file, diff --git a/gio/gfile.h b/gio/gfile.h index c2e437b..47fa184 100644 --- a/gio/gfile.h +++ b/gio/gfile.h @@ -39,7 +39,7 @@ G_BEGIN_DECLS /** * GFileQueryInfoFlags: - * @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: + * @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: Don't follow symlinks. * * Flags used when querying a #GFileInfo. */ @@ -49,8 +49,9 @@ typedef enum { /** * GFileCreateFlags: - * @G_FILE_CREATE_FLAGS_NONE: - * @G_FILE_CREATE_FLAGS_PRIVATE: + * @G_FILE_CREATE_FLAGS_NONE: No flags set. + * @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. */ @@ -62,7 +63,7 @@ typedef enum { /** * GFileCopyFlags: * @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_ALL_METADATA: Copy all file metadata (see #GFileInfo). * diff --git a/gio/gfileattribute.c b/gio/gfileattribute.c index 9bba549..394404e 100644 --- a/gio/gfileattribute.c +++ b/gio/gfileattribute.c @@ -30,8 +30,8 @@ /** * SECTION:gfileattribute - * @short_description: Key-Value Paired File Attributes. - * @see_also: #GFile, #GFileInfo. + * @short_description: Key-Value Paired File Attributes + * @see_also: #GFile, #GFileInfo * * File attributes in GIO consist of a list of key-value pairs. * diff --git a/gio/gfileenumerator.c b/gio/gfileenumerator.c index 7422bb9..4416151 100644 --- a/gio/gfileenumerator.c +++ b/gio/gfileenumerator.c @@ -29,7 +29,7 @@ /** * SECTION:gfileenumerator - * @short_description: Enumerated Files Routines. + * @short_description: Enumerated Files Routines * * **/ diff --git a/gio/gfileicon.c b/gio/gfileicon.c index be3f3fe..5a66879 100644 --- a/gio/gfileicon.c +++ b/gio/gfileicon.c @@ -27,8 +27,8 @@ /** * SECTION:gfileicon - * @short_description: Icons for given files. - * @see_also: #GIcon, #GLoadableIcon. + * @short_description: Icons for given files + * @see_also: #GIcon, #GLoadableIcon * @include: gio/gfileicon.h * * #GFileIcon gets the default icon for a #GFile. diff --git a/gio/gfileinfo.c b/gio/gfileinfo.c index f72e3ee..3df6325 100644 --- a/gio/gfileinfo.c +++ b/gio/gfileinfo.c @@ -22,8 +22,8 @@ /** * SECTION:gfileinfo - * @short_description: File Information and Attributes. - * @see_also: #GFile. + * @short_description: File Information and Attributes + * @see_also: #GFile * * Functionality for manipulating basic metadata for files. #GFileInfo * implements methods for getting information that all files should diff --git a/gio/gfileinputstream.c b/gio/gfileinputstream.c index 51b0ae0..94c0269 100644 --- a/gio/gfileinputstream.c +++ b/gio/gfileinputstream.c @@ -31,7 +31,7 @@ /** * SECTION:gfileinputstream * @short_description: file input streaming operations - * @see_also: #GInputStream, #GDataInputStream, #GSeekable. + * @see_also: #GInputStream, #GDataInputStream, #GSeekable * * * diff --git a/gio/gfilenamecompleter.c b/gio/gfilenamecompleter.c index 2b5b622..76e6276 100644 --- a/gio/gfilenamecompleter.c +++ b/gio/gfilenamecompleter.c @@ -29,7 +29,7 @@ /** * SECTION:gfilenamecompleter - * @short_description: Filename Completer. + * @short_description: Filename Completer * * Completes partial file and directory names given a partial string by * looking in the file system for clues. Can return a list of possible diff --git a/gio/gfileoutputstream.c b/gio/gfileoutputstream.c index 35eaf68..f54a583 100644 --- a/gio/gfileoutputstream.c +++ b/gio/gfileoutputstream.c @@ -31,7 +31,7 @@ /** * SECTION:gfileoutputstream * @short_description: file output streaming operations - * @see_also: #GOutputStream, #GDataOutputStream, #GSeekable. + * @see_also: #GOutputStream, #GDataOutputStream, #GSeekable * * * diff --git a/gio/gfilterinputstream.c b/gio/gfilterinputstream.c index 9b40cbe..078a479 100644 --- a/gio/gfilterinputstream.c +++ b/gio/gfilterinputstream.c @@ -27,7 +27,7 @@ /** * SECTION:gfilterinputstream - * @short_description: Filter Input Stream. + * @short_description: Filter Input Stream * **/ diff --git a/gio/gioerror.c b/gio/gioerror.c index 829383c..e3bb348 100644 --- a/gio/gioerror.c +++ b/gio/gioerror.c @@ -26,7 +26,7 @@ /** * SECTION:gioerror - * @short_description: Error helper functions. + * @short_description: Error helper functions * **/ diff --git a/gio/gmemoryinputstream.c b/gio/gmemoryinputstream.c index ee29df1..0e9dbac 100644 --- a/gio/gmemoryinputstream.c +++ b/gio/gmemoryinputstream.c @@ -31,7 +31,7 @@ /** * SECTION:gmemoryinputstream * @short_description: streaming input operations on memory chunks - * @see_also: #GMemoryOutputStream. + * @see_also: #GMemoryOutputStream * * #GMemoryInputStream is a class for using arbitrary * memory chunks as input for GIO streaming input operations. diff --git a/gio/gmemoryoutputstream.c b/gio/gmemoryoutputstream.c index ae5ac9d..b3c2a10 100644 --- a/gio/gmemoryoutputstream.c +++ b/gio/gmemoryoutputstream.c @@ -31,7 +31,7 @@ /** * SECTION:gmemoryoutputstream * @short_description: streaming output operations on memory chunks - * @see_also: #GMemoryInputStream. + * @see_also: #GMemoryInputStream * * #GMemoryOutputStream is a class for using arbitrary * memory chunks as output for GIO streaming output operations. diff --git a/gio/gmountoperation.c b/gio/gmountoperation.c index 4c0895e..bdb0b3a 100644 --- a/gio/gmountoperation.c +++ b/gio/gmountoperation.c @@ -30,7 +30,7 @@ /** * SECTION:gmountoperation - * @short_description: Authentication methods for mountable locations. + * @short_description: Authentication methods for mountable locations * * #GMountOperation provides a mechanism for authenticating mountable * operations, such as loop mounting files, hard drive partitions or diff --git a/gio/gseekable.c b/gio/gseekable.c index bc2a2b2..fba1dec 100644 --- a/gio/gseekable.c +++ b/gio/gseekable.c @@ -26,8 +26,8 @@ /** * SECTION:gseekable - * @short_description: Stream seeking interface. - * @see_also: #GInputStream, #GOutputStream. + * @short_description: Stream seeking interface + * @see_also: #GInputStream, #GOutputStream * * #GSeekable is implemented by streams (implementations of * #GInputStream or #GOutputStream) that support seeking. diff --git a/gio/gsimpleasyncresult.c b/gio/gsimpleasyncresult.c index 0a99c69..b099783 100644 --- a/gio/gsimpleasyncresult.c +++ b/gio/gsimpleasyncresult.c @@ -36,8 +36,8 @@ /** * SECTION:gsimpleasyncresult - * @short_description: simple asynchronous results implementation. - * @see_also: #GAsyncResult. + * @short_description: simple asynchronous results implementation + * @see_also: #GAsyncResult * * Implements #GAsyncResult for simple cases. Most of the time, this * will be all an application needs, and will be used transparently. diff --git a/gio/gthemedicon.c b/gio/gthemedicon.c index d46c726..38b83eb 100644 --- a/gio/gthemedicon.c +++ b/gio/gthemedicon.c @@ -27,7 +27,7 @@ /** * SECTION:gthemedicon * @short_description: Themed Icons - * @see_also: #GIcon, #GLoadableIcon. + * @see_also: #GIcon, #GLoadableIcon * * #GThemedIcon is an implementation of #GIcon for themed icons. **/ diff --git a/gio/gunixinputstream.c b/gio/gunixinputstream.c index 286d228..0057180 100644 --- a/gio/gunixinputstream.c +++ b/gio/gunixinputstream.c @@ -42,7 +42,7 @@ /** * SECTION:gunixinputstream * @short_description: Unix Input Stream - * @see_also: #GInputStream. + * @see_also: #GInputStream * * #GUnixInputStream implements #GInputStream for reading from a * unix file descriptor, including asynchronous operations. The file diff --git a/gio/gunixoutputstream.c b/gio/gunixoutputstream.c index ee02f27..e9da5c5 100644 --- a/gio/gunixoutputstream.c +++ b/gio/gunixoutputstream.c @@ -42,7 +42,7 @@ /** * SECTION:gunixoutputstream * @short_description: Unix Output Stream - * @see_also: #GOutputStream. + * @see_also: #GOutputStream * * #GUnixOutputStream implements #GOutputStream for writing to a a * unix file descriptor, including asynchronous operations. The file -- 2.7.4