glib r6410 - trunk/gio

[alexl svn gnome org]

Author: alexl
Date: Tue Jan 29 12:23:24 2008
New Revision: 6410
URL: http://svn.gnome.org/viewvc/glib?rev=6410&view=rev

Log:
Add docs


Modified:
   trunk/gio/gfile.c

Modified: trunk/gio/gfile.c
==============================================================================
--- trunk/gio/gfile.c	(original)
+++ trunk/gio/gfile.c	Tue Jan 29 12:23:24 2008
@@ -4572,6 +4572,22 @@
  *   Utility functions                      *
  ********************************************/
 
+/**
+ * g_file_query_default_handler:
+ * @file: a #GFile to open.
+ * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError, or %NULL
+ *
+ * Returns the #GAppInfo that is registered as the default
+ * application to handle the file specified bu @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. 
+ *
+ * Returns: a #GAppInfo if the handle was found, %NULL if there were errors.
+ * When you are done with it, release it with g_object_unref()
+ **/
 GAppInfo *
 g_file_query_default_handler (GFile                  *file,
 			      GCancellable           *cancellable,