[glib] GCancellable: Small annotation additions
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] GCancellable: Small annotation additions
- Date: Thu, 25 Aug 2011 01:26:03 +0000 (UTC)
commit 471593ebf0e133f97c08b27f357bc16ece5f81ec
Author: Matthias Clasen <mclasen redhat com>
Date: Wed Aug 24 21:23:36 2011 -0400
GCancellable: Small annotation additions
https://bugzilla.gnome.org/show_bug.cgi?id=657243
gio/gcancellable.c | 26 +++++++++++++-------------
1 files changed, 13 insertions(+), 13 deletions(-)
---
diff --git a/gio/gcancellable.c b/gio/gcancellable.c
index 229f00c..ba7911b 100644
--- a/gio/gcancellable.c
+++ b/gio/gcancellable.c
@@ -286,12 +286,12 @@ g_cancellable_reset (GCancellable *cancellable)
/**
* g_cancellable_is_cancelled:
- * @cancellable: a #GCancellable or NULL.
- *
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ *
* Checks if a cancellable job has been cancelled.
- *
- * Returns: %TRUE if @cancellable is cancelled,
- * FALSE if called with %NULL or if item is not cancelled.
+ *
+ * Returns: %TRUE if @cancellable is cancelled,
+ * FALSE if called with %NULL or if item is not cancelled.
**/
gboolean
g_cancellable_is_cancelled (GCancellable *cancellable)
@@ -301,17 +301,17 @@ g_cancellable_is_cancelled (GCancellable *cancellable)
/**
* g_cancellable_set_error_if_cancelled:
- * @cancellable: a #GCancellable object.
- * @error: #GError to append error state to.
- *
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: #GError to append error state to
+ *
* If the @cancellable is cancelled, sets the error to notify
* that the operation was cancelled.
- *
- * Returns: %TRUE if @cancellable was cancelled, %FALSE if it was not.
- **/
+ *
+ * Returns: %TRUE if @cancellable was cancelled, %FALSE if it was not
+ */
gboolean
g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
- GError **error)
+ GError **error)
{
if (g_cancellable_is_cancelled (cancellable))
{
@@ -321,7 +321,7 @@ g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
_("Operation was cancelled"));
return TRUE;
}
-
+
return FALSE;
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]