2007-11-27 Matthias Clasen <mclasen@redhat.com>
+ * gcontenttype.c: Move doc comments to the unix section.
+
+ * *.[hc]: More trivial doc corrections.
+
+2007-11-27 Matthias Clasen <mclasen@redhat.com>
+
* gpollfilemonitor.c:
* gunixmounts.c:
* gvfs.c:
/**
- * g_app_info_can_remove_support_type:
+ * g_app_info_can_remove_supports_type:
* @appinfo: a #GAppInfo.
*
* Checks if a supported content type can be removed from an application.
#include "gcontenttypeprivate.h"
#include "glibintl.h"
-/* This really sucks. GTK-Doc isn't smart enough to realize there are two
- * different versions of the functions within this file, based on the platform.
- * I can move the definitions out of this file, but that's ugly.
- */
-
/**
* SECTION:gcontenttype
* @short_description: platform specific content typing
return value_utf8;
}
-/**
- * g_content_type_equals:
- * @type1: a content type string.
- * @type2: a content type string.
- *
- * Compares two content types for equality.
- *
- * Returns: %TRUE if the two strings are identical or equivalent,
- * %FALSE otherwise.
- **/
gboolean
g_content_type_equals (const char *type1,
const char *type2)
return res;
}
-/**
- * g_content_type_is_a:
- * @type: a content type string.
- * @supertype: a string.
- *
- * Determines if @type is a subset of @supertype.
- *
- * Returns: %TRUE if @type is a kind of @supertype,
- * %FALSE otherwise.
- **/
gboolean
g_content_type_is_a (const char *type,
const char *supertype)
return res;
}
-/**
- * g_content_type_is_unknown:
- * @type: a content type string.
- *
- * Checks if the content type is known by GIO.
- *
- * Returns: %TRUE if the type is unknown.
- **/
gboolean
g_content_type_is_unknown (const char *type)
{
return strcmp ("*", type) == 0;
}
-/**
- * g_content_type_get_description:
- * @type: a content type string.
- *
- * Gets the human readable description of the content type.
- *
- * Returns: a short description of the content type @type.
- **/
char *
g_content_type_get_description (const char *type)
{
return g_strdup_printf (_("%s filetype"), type);
}
-/**
- * g_content_type_get_mime_type:
- * @type: a content type string.
- *
- * Gets the mime-type for the content type.
- *
- * Returns: the registered mime-type for the given @type.
- **/
char *
g_content_type_get_mime_type (const char *type)
{
return g_strdup ("application/octet-stream");
}
-/**
- * g_content_type_get_icon:
- * @type: a content type string.
- *
- * Gets the icon for a content type.
- *
- * Returns: #GIcon corresponding to the content type.
- **/
GIcon *
g_content_type_get_icon (const char *type)
{
return NULL;
}
-/**
- * g_content_type_can_be_executable:
- * @type: a content type string.
- *
- * Checks if a content type can be executable. Note that for instance
- * things like text files can be executables (i.e. scripts and batch files).
- *
- * Returns: %TRUE if the file type corresponds to a type that
- * can be executable, %FALSE otherwise.
- **/
gboolean
g_content_type_can_be_executable (const char *type)
{
return TRUE;
}
-/**
- * g_content_type_guess:
- * @filename: a string.
- * @data: a stream of data.
- * @data_size: the size of @data.
- * @result_uncertain: a flag indicating the certainty of the
- * result.
- *
- * Guesses the content type based on example data. If the function is
- * uncertain, @result_uncertain will be set to %TRUE.
- *
- * Returns: a string indicating a guessed content type for the
- * given data.
- **/
char *
g_content_type_guess (const char *filename,
const guchar *data,
return g_strdup ("*");
}
-/**
- * g_content_types_get_registered:
- *
- * Gets a list of strings containing the registered content types on
- * the system.
- *
- * Returns: #GList of the registered content types.
- **/
GList *
g_content_types_get_registered (void)
{
return (char **)g_ptr_array_free (array, FALSE);
}
+/**
+ * g_content_type_equals:
+ * @type1: a content type string.
+ * @type2: a content type string.
+ *
+ * Compares two content types for equality.
+ *
+ * Returns: %TRUE if the two strings are identical or equivalent,
+ * %FALSE otherwise.
+ **/
gboolean
g_content_type_equals (const char *type1,
const char *type2)
return res;
}
+/**
+ * g_content_type_is_a:
+ * @type: a content type string.
+ * @supertype: a string.
+ *
+ * Determines if @type is a subset of @supertype.
+ *
+ * Returns: %TRUE if @type is a kind of @supertype,
+ * %FALSE otherwise.
+ **/
gboolean
g_content_type_is_a (const char *type,
const char *supertype)
return res;
}
+/**
+ * g_content_type_is_unknown:
+ * @type: a content type string.
+ *
+ * Checks if the content type is known by GIO.
+ *
+ * Returns: %TRUE if the type is unknown.
+ **/
gboolean
g_content_type_is_unknown (const char *type)
{
return g_strdup_printf (_("%s type"), mimetype);
}
+/**
+ * g_content_type_get_description:
+ * @type: a content type string.
+ *
+ * Gets the human readable description of the content type.
+ *
+ * Returns: a short description of the content type @type.
+ **/
char *
g_content_type_get_description (const char *type)
{
return comment;
}
+/**
+ * g_content_type_get_mime_type:
+ * @type: a content type string.
+ *
+ * Gets the mime-type for the content type.
+ *
+ * Returns: the registered mime-type for the given @type.
+ **/
char *
g_content_type_get_mime_type (const char *type)
{
return g_strdup (type);
}
+/**
+ * g_content_type_get_icon:
+ * @type: a content type string.
+ *
+ * Gets the icon for a content type.
+ *
+ * Returns: #GIcon corresponding to the content type.
+ **/
GIcon *
g_content_type_get_icon (const char *type)
{
* g_content_type_can_be_executable:
* @type: a content type string.
*
- * Returns: %TRUE if the file type corresponds to something that
- * can be executable, %FALSE otherwise. Note that for instance
- * things like textfiles can be executables (i.e. scripts)
+ * Checks if a content type can be executable. Note that for instance
+ * things like text files can be executables (i.e. scripts and batch files).
+ *
+ * Returns: %TRUE if the file type corresponds to a type that
+ * can be executable, %FALSE otherwise.
**/
gboolean
g_content_type_can_be_executable (const char *type)
return TRUE;
}
+/**
+ * g_content_type_guess:
+ * @filename: a string.
+ * @data: a stream of data.
+ * @data_size: the size of @data.
+ * @result_uncertain: a flag indicating the certainty of the
+ * result.
+ *
+ * Guesses the content type based on example data. If the function is
+ * uncertain, @result_uncertain will be set to %TRUE.
+ *
+ * Returns: a string indicating a guessed content type for the
+ * given data.
+ **/
char *
g_content_type_guess (const char *filename,
const guchar *data,
g_free (mimedir);
}
+/**
+ * g_content_types_get_registered:
+ *
+ * Gets a list of strings containing the registered content types on
+ * the system.
+ *
+ * Returns: #GList of the registered content types.
+ **/
GList *
g_content_types_get_registered (void)
{
/**
* g_app_info_create_from_commandline:
- * @commandline:
- * @application_name:
- * @flags:
- * @error: a #GError location to store the error occuring, or %NULL to
- * ignore.
+ * @commandline: the commandline to use
+ * @application_name: the application name, or %NULL to use @commandline
+ * @flags: flags that can specify details of the created #GAppInfo
+ * @error: a #GError location to store the error occuring, %NULL to ignore.
+ *
+ * Creates a new #GAppInfo from the given information.
+ *
* Returns: new #GAppInfo for given command.
**/
GAppInfo *
/**
* g_app_info_get_all_for_type:
- * @content_type:
+ * @content_type: the content type to find a #GAppInfo for
*
* Gets a list of all #GAppInfo s for a given content type.
*
/**
* g_app_info_get_default_for_type:
- * @content_type:
- * @must_support_uris:
+ * @content_type: the content type to find a #GAppInfo for
+ * @must_support_uris: if %TRUE, the #GAppInfo is expected to
+ * support URIs
*
* Gets the #GAppInfo that correspond to a given content type.
- * If @must_support_uris is true, the #GAppInfo is expected to
- * support URIs.
*
* Returns: #GAppInfo for given @content_type.
**/
* g_drive_get_name:
* @drive: a #GDrive.
*
- * Returns: string containing @drive's name.
+ * Gets the name of @drive.
*
- * The returned string should be freed when no longer needed.
+ * Returns: a string containing @drive's name. The returned
+ * string should be freed when no longer needed.
**/
char *
g_drive_get_name (GDrive *drive)
}
/**
- * g_file_parse_name:
+ * g_file_get_parse_name:
* @file: input #GFile.
*
* Gets the parsed name for the #GFile.
* g_file_read:
* @file: #GFile to read.
* @cancellable: a #GCancellable
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Reads a whole file into a #GFileInputStream. Fails returning %NULL if
* given #GFile points to a directory.
* @file: input #GFile.
* @flags: a set of #GFileCreateFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError, or %NULL
*
* If the #GFileIface for @file does not support appending to files, then
* @error will be set to %G_IO_ERROR_NOT_SUPPORTED and %NULL will be returned.
* @file: input #GFile.
* @flags: a set of #GFileCreateFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* If the #GFileIface for @file does not support creating files, then
* @error will be set to %G_IO_ERROR_NOT_SUPPORTED and %NULL will be returned.
* @make_backup: a #gboolean.
* @flags: a set of #GFileCreateFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError, or %NULL
*
* If the #GFileIface for @file does not support streaming operations, then
* @error will be set to %G_IO_ERROR_NOT_SUPPORTED and %NULL will be returned.
* g_file_read_finish:
* @file: input #GFile.
* @res: a #GAsyncResult.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes an asynchronous file read operation started with
* g_file_read_async().
* g_file_append_to_finish:
* @file: input #GFile.
* @res: #GAsyncResult
- * @error: a #GError.
+ * @error: a #GError, or #NULL
*
* Finishes appending to a file started with g_file_append_to_async().
*
* g_file_create_finish:
* @file: input #GFile.
* @res: a #GAsyncResult.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes creating a file started with g_file_create_async().
*
* g_file_replace_finish:
* @file: input #GFile.
* @res: a #GAsyncResult.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes replacing the contents of the file started by
* g_file_replace_async(). This is typically called within
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @progress_callback: function to callback with progress information
* @progress_callback_data: userdata to pass to @progress_callback
- * @error: #GError to set on error
+ * @error: #GError to set on error, or %NULL
*
* <!-- Source Friendly Version
* List of possible errors resulting from g_file_copy():
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @progress_callback: GFileProgressCallback function for updates.
* @progress_callback_data: gpointer to user data for the callback function.
- * @error: #GError for returning error conditions.
+ * @error: #GError for returning error conditions, or %NULL
*
* List of possible returns from g_file_move() with given source,
* destination, and flags:
* g_file_make_directory
* @file: input #GFile.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* g_file_delete:
* @file: input #GFile.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Deletes a file.
*
* g_file_trash:
* @file: #GFile to send to trash.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sends @file to the virtual file system "Trash" location. If the
* virtual file system does not have support having a "Trash" location,
* @file: input #GFile.
* @display_name: a string.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sets the display name for @file. If the display name contains invalid
* characters, @error will be set to %G_IO_ERROR_INVALID_ARGUMENT. For the
* g_file_set_display_name_finish:
* @file: input #GFile.
* @res: a #GAsyncResult.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes setting a display name started with g_file_set_display_name_async().
*
* g_file_query_settable_attributes:
* @file: input #GFile.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* g_file_query_writable_namespaces:
* @file: input #GFile.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* @value: a set of #GFileAttributeValue.
* @flags: a set of #GFileQueryInfoFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sets an attribute in the file with attribute name @attribute to @value.
* If setting attributes is not suppored by the #GFileIface for @file,
* @info: a #GFileInfo.
* @flags: #GFileQueryInfoFlags
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Tries to set all attributes in the #GFileInfo on the target values, not stopping
* on the first error.
* @file: input #GFile.
* @result: a #GAsyncResult.
* @info: a #GFileInfo.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes setting an attribute started in g_file_set_attributes_async().
*
* @value: a string containing the attribute's value.
* @flags: #GFileQueryInfoFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. If
* @attribute is of a different type, this operation will fail.
* @value: a string containing the attribute's new value.
* @flags: a #GFileQueryInfoFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. If
* @attribute is of a different type, this operation will fail, returning %FALSE.
* @value: a #guint32 containing the attribute's new value.
* @flags: a #GFileQueryInfoFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. If
* @attribute is of a different type, this operation will fail.
* @value: a #gint32 containing the attribute's new value.
* @flags: a #GFileQueryInfoFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. If
* @attribute is of a different type, this operation will fail.
* @value: a #guint64 containing the attribute's new value.
* @flags: a #GFileQueryInfoFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. If
* @attribute is of a different type, this operation will fail.
* @value: a #guint64 containing the attribute's new value.
* @flags: a #GFileQueryInfoFlags.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. If
* @attribute is of a different type, this operation will fail.
* g_file_mount_mountable_finish:
* @file: input #GFile.
* @result: a #GAsyncResult.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Returns: a #GFile or %NULL on error.
**/
* g_file_unmount_mountable_finish:
* @file: input #GFile.
* @result: a #GAsyncResult.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Returns: %TRUE if the operation finished successfully. %FALSE
* otherwise.
* g_file_eject_mountable_finish:
* @file: input #GFile.
* @result: a #GAsyncResult.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes an asynchronous eject operation started by
* g_file_eject_mountable().
* g_mount_for_location_finish:
* @location: input #GFile.
* @result: a #GAsyncResult.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes a mount operation started by g_mount_for_location().
*
* @contents: a location to place the contents of the file.
* @length: a location to place the length of the contents of the file.
* @etag_out: a location to place the current entity tag for the file.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* @contents: a location to place the contents of the file.
* @length: a location to place the length of the contents of the file.
* @etag_out: a location to place the current entity tag for the file.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Returns: %TRUE if the load was successful. If %FALSE and @error is
* present, it will be set appropriately.
* @contents: a location to place the contents of the file.
* @length: a location to place the length of the contents of the file.
* @etag_out: a location to place the current entity tag for the file.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes an asynchronous load of the @file's contents. The contents
* are placed in @contents, and @length is set to the size of the @contents
* @flags: a set of #GFileCreateFlags.
* @new_etag: a location to a new entity tag for the document.
* @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Replaces the contents of @file with @contents of @length bytes. The old
* @etag will be replaced with the @new_etag. If @make_backup is %TRUE,
g_return_val_if_fail (G_IS_FILE (file), FALSE);
g_return_val_if_fail (contents != NULL, FALSE);
- out = g_file_replace (file,
- etag,
- make_backup,
- flags,
- cancellable,
- error);
+ out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
if (out == NULL)
return FALSE;
* @file: input #GFile.
* @res: a #GAsyncResult.
* @new_etag: a location of a new entity tag for the document.
- * @error: a #GError.
+ * @error: a #GError, or %NULL
*
* Finishes an asynchronous replace of the given @file. Sets
* @new_etag to the new entity tag for the document, if present.
* @list: a #GFileAttributeInfoList.
* @name: the name of the attribute to lookup.
*
+ * Gets the file attribute with the name @name from @list.
+ *
* Returns: a #GFileAttributeInfo for the @name, or %NULL if an
* attribute isn't found.
**/
*
* Adds a new attribute with @name to the @list, setting
* its @type and @flags.
- *
**/
void
g_file_attribute_info_list_add (GFileAttributeInfoList *list,
**/
#define G_FILE_ATTRIBUTE_THUMBNAIL_PATH "thumbnail:path" /* bytestring */
/**
- * G_FILE_ATTRIBUTE_THUMBNAIL_THUMNAILING_FAILED:
+ * G_FILE_ATTRIBUTE_THUMBNAILING_FAILED:
*
* A key in the "thumbnail" namespace for checking if thumbnailing failed.
* This attribute is %TRUE if thumbnailing failed. Corresponding
/**
* g_file_monitor_is_cancelled:
- * @monitor:
+ * @monitor: a #GFileMonitor
*
+ * Returns whether the monitor is canceled.
+ *
* Returns: %TRUE if monitor is canceled. %FALSE otherwise.
**/
gboolean
* g_filename_completer_get_completion_suffix:
* @completer: the filename completer.
* @initial_text: text to be completed.
- *
- * Returns: a completed string. This string is not owned by GIO, so
- * remember to g_free() it when finished.
+ *
+ * Obtains a completion for @initial_text from @completer.
+ *
+ * Returns: a completed string, or %NULL if no completion exists.
+ * This string is not owned by GIO, so remember to g_free() it
+ * when finished.
**/
char *
g_filename_completer_get_completion_suffix (GFilenameCompleter *completer,
* g_filter_input_stream_get_base_stream:
* @stream: a #GFilterInputStream.
*
+ * Gets the base stream for the filter stream.
+ *
* Returns: a #GInputStream.
**/
GInputStream *
{
}
+/**
+ * g_filter_output_stream_get_base_stream:
+ * @stream: a #GFilterOutputStream.
+ *
+ * Gets the base stream for the filter stream.
+ *
+ * Returns: a #GOutputStream.
+ **/
GOutputStream *
g_filter_output_stream_get_base_stream (GFilterOutputStream *stream)
{
/**
* g_output_stream_close_async:
* @stream: A #GOutputStream.
+ * @io_priority: the io priority of the request.
* @callback: callback to call when the request is satisfied
* @user_data: the data to pass to callback function
* @cancellable: optional cancellable object
*
- * Requests an asynchronous closes of the stream, releasing resources related to it.
+ * Requests an asynchronous close of the stream, releasing resources related to it.
* When the operation is finished @callback will be called, giving the results.
*
* For behaviour details see g_output_stream_close().
* by the operation; all of the simple return cases are covered.
*
* Most of the time, an application will not need to know of the details
- * of this API; it is handled transparently, and any necessary operations are handled by
- * #GAsyncResult's interface. However, if implementing a new GIO module, for writing
- * language bindings, or for complex applications that need better control of how
- * asynchronous operations are completed, it is important to understand this functionality.
- *
- * To create a new #GSimpleAsyncResult, call g_simple_async_result_new(). If the
- * result needs to be created for a #GError, use g_simple_async_result_new_from_error().
- * If a #GError is not available (e.g. the asynchronous operation's doesn't take a #GError
- * argument), but the result still needs to be created for an error condition, use
+ * of this API; it is handled transparently, and any necessary operations are
+ * handled by #GAsyncResult's interface. However, if implementing a new GIO
+ * module, for writing language bindings, or for complex applications that
+ * need better control of how asynchronous operations are completed, it is
+ * important to understand this functionality.
+ *
+ * To create a new #GSimpleAsyncResult, call g_simple_async_result_new(). If
+ * the result needs to be created for a #GError, use
+ * g_simple_async_result_new_from_error(). If a #GError is not available (e.g.
+ * the asynchronous operation's doesn't take a #GError argument), but the result
+ * still needs to be created for an error condition, use
* g_simple_async_result_new_error() (or g_simple_async_result_set_error_va()
- * if your application or binding requires passing a variable argument list directly),
- * and the error can then be propegated through the use of g_simple_async_result_propagate_error().
+ * if your application or binding requires passing a variable argument list
+ * directly), and the error can then be propegated through the use of
+ * g_simple_async_result_propagate_error().
*
* An asynchronous operation can be made to ignore a cancellation event by calling
- * g_simple_async_result_set_handle_cancellation() with a #GSimpleAsyncResult for the operation
- * and %FALSE.
+ * g_simple_async_result_set_handle_cancellation() with a #GSimpleAsyncResult
+ * for the operation and %FALSE.
*
* GSimpleAsyncResult can integrate into GLib's Main Event Loop <!-- TODO: Crosslink -->,
- * or it can use #GThread<!-- -->s if available. g_simple_async_result_complete() will finish an
- * I/O task directly within the main event loop. g_simple_async_result_complete_in_idle() will integrate
- * the I/O task into the main event loop as an idle function and g_simple_async_result_run_in_thread()
+ * or it can use #GThread<!-- -->s if available. g_simple_async_result_complete()
+ * will finish an I/O task directly within the main event loop.
+ * g_simple_async_result_complete_in_idle() will integrate the I/O task into the
+ * main event loop as an idle function and g_simple_async_result_run_in_thread()
* will run the job in a separate thread.
*
- * To set the results of an asynchronous function, g_simple_async_result_set_op_res_gpointer(),
- * g_simple_async_result_set_op_res_gboolean(), and g_simple_async_result_set_op_res_gssize()
- * are provided, setting the operation's result to a gpointer, gboolean, or gssize, respectively.
- *
- * Likewise, to get the result of an asynchronous function, g_simple_async_result_get_op_res_gpointer(),
- * g_simple_async_result_get_op_res_gboolean(), and g_simple_async_result_get_op_res_gssize() are
- * provided, getting the operation's result as a gpointer, gboolean, and gssize, respectively.
- *
+ * To set the results of an asynchronous function,
+ * g_simple_async_result_set_op_res_gpointer(),
+ * g_simple_async_result_set_op_res_gboolean(), and
+ * g_simple_async_result_set_op_res_gssize()
+ * are provided, setting the operation's result to a gpointer, gboolean, or
+ * gssize, respectively.
+ *
+ * Likewise, to get the result of an asynchronous function,
+ * g_simple_async_result_get_op_res_gpointer(),
+ * g_simple_async_result_get_op_res_gboolean(), and
+ * g_simple_async_result_get_op_res_gssize() are
+ * provided, getting the operation's result as a gpointer, gboolean, and
+ * gssize, respectively.
**/
static void g_simple_async_result_async_result_iface_init (GAsyncResultIface *iface);
/**
* g_volume_monitor_get:
*
- * Returns: a #GVolumeMonitor.
+ * Gets the volume monitor used by gio.
+ *
+ * Returns: a reference to the #GVolumeMonitor used by gio. Call
+ * g_object_unref() when done with it.
**/
GVolumeMonitor *
g_volume_monitor_get (void)
G_LOCK (the_volume_monitor);
- if (the_volume_monitor )
+ if (the_volume_monitor)
vm = G_VOLUME_MONITOR (g_object_ref (the_volume_monitor));
else
{
projects / platform / upstream / glib.git / commitdiff