luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-09 19:06:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

gcancellable: Mention nullability in g_cancellable_cancel() docs

Browse Source 
Calling g_cancellable_cancel(NULL) is an explicitly allowed no-op, for
convenience. Document and annotate that.
This commit is contained in:
Philip Withnall 2015-02-24 10:57:14 +00:00
parent 99232046d6
commit e966cc51de
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
gio/gcancellable.c
View File

@ -458,7 +458,7 @@ g_cancellable_release_fd (GCancellable *cancellable)
/**
* g_cancellable_cancel:
* @cancellable: a #GCancellable object.
* @cancellable: (nullable): a #GCancellable object.
*
* Will set @cancellable to cancelled, and will emit the
* #GCancellable::cancelled signal. (However, see the warning about
@ -469,7 +469,9 @@ g_cancellable_release_fd (GCancellable *cancellable)
* it from a thread other than the one running the operation that was
* passed the @cancellable.
*
* The convention within gio is that cancelling an asynchronous
* If @cancellable is %NULL, this function returns immediately for convenience.
*
* The convention within GIO is that cancelling an asynchronous
* operation causes it to complete asynchronously. That is, if you
* cancel the operation from the same thread in which it is running,
* then the operation's #GAsyncReadyCallback will not be invoked until