Add docs for udisks_base_job_get_auto_estimate()
authorDavid Zeuthen <zeuthen@gmail.com>
Tue, 2 Oct 2012 17:40:12 +0000 (13:40 -0400)
committerDavid Zeuthen <zeuthen@gmail.com>
Tue, 2 Oct 2012 17:40:12 +0000 (13:40 -0400)
Signed-off-by: David Zeuthen <zeuthen@gmail.com>
src/udisksbasejob.c

index 1144d2d..90299b8 100644 (file)
@@ -442,6 +442,14 @@ job_iface_init (UDisksJobIface *iface)
 
 /* ---------------------------------------------------------------------------------------------------- */
 
+/**
+ * udisks_base_job_get_auto_estimate:
+ * @job: A #UDisksBaseJob.
+ *
+ * Gets whether auto-estimation is being used.
+ *
+ * Returns: %TRUE if auto-estimation is being used, %FALSE otherwise.
+ */
 gboolean
 udisks_base_job_get_auto_estimate (UDisksBaseJob  *job)
 {