luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-15 20:18:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

GCancellable: Small annotation additions

Browse Source 
https://bugzilla.gnome.org/show_bug.cgi?id=657243
This commit is contained in:
Matthias Clasen 2011-08-24 21:23:36 -04:00
parent 3cb189c1ce
commit 471593ebf0
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
gio/gcancellable.c
View File

@ -286,12 +286,12 @@ g_cancellable_reset (GCancellable *cancellable)
/** /**
* g_cancellable_is_cancelled: * g_cancellable_is_cancelled:
* @cancellable: a #GCancellable or NULL. * @cancellable: (allow-none): a #GCancellable or %NULL
* *
* Checks if a cancellable job has been cancelled. * Checks if a cancellable job has been cancelled.
* *
* Returns: %TRUE if @cancellable is cancelled, * Returns: %TRUE if @cancellable is cancelled,
* FALSE if called with %NULL or if item is not cancelled. * FALSE if called with %NULL or if item is not cancelled.
**/ **/
gboolean gboolean
g_cancellable_is_cancelled (GCancellable *cancellable) g_cancellable_is_cancelled (GCancellable *cancellable)
@ -301,17 +301,17 @@ g_cancellable_is_cancelled (GCancellable *cancellable)
/** /**
* g_cancellable_set_error_if_cancelled: * g_cancellable_set_error_if_cancelled:
* @cancellable: a #GCancellable object. * @cancellable: (allow-none): a #GCancellable or %NULL
* @error: #GError to append error state to. * @error: #GError to append error state to
* *
* If the @cancellable is cancelled, sets the error to notify * If the @cancellable is cancelled, sets the error to notify
* that the operation was cancelled. * 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 gboolean
g_cancellable_set_error_if_cancelled (GCancellable *cancellable, g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
GError **error) GError **error)
{ {
if (g_cancellable_is_cancelled (cancellable)) if (g_cancellable_is_cancelled (cancellable))
{ {
@ -321,7 +321,7 @@ g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
_("Operation was cancelled")); _("Operation was cancelled"));
return TRUE; return TRUE;
} }
return FALSE; return FALSE;
} }