[gobject-introspection/wip/tintou/closure-documentation] Fix misleading documentation for `closure` annotation
- From: Corentin Noël <corentinnoel src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gobject-introspection/wip/tintou/closure-documentation] Fix misleading documentation for `closure` annotation
- Date: Sun, 23 Jun 2019 14:50:50 +0000 (UTC)
commit 266b174c375a720d625ae6253ddb434118b70cd0
Author: Corentin Noël <corentin elementary io>
Date: Sun Jun 23 16:50:17 2019 +0200
Fix misleading documentation for `closure` annotation
docs/website/annotations/giannotations.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
---
diff --git a/docs/website/annotations/giannotations.rst b/docs/website/annotations/giannotations.rst
index cacc20de..3d4f8bad 100644
--- a/docs/website/annotations/giannotations.rst
+++ b/docs/website/annotations/giannotations.rst
@@ -123,13 +123,13 @@ Support for GObject closures
-
* - ``(closure)``
- parameters
- - The parameter is a "``user_data``" for callbacks.
- Many bindings can pass ``NULL`` here.
+ - The parameter is a callback and has a corresponding "``user_data``"
+ parameter which many bindings can pass ``NULL``.
-
* - ``(closure CLOSURE)``
- parameters
- - The parameter is a "``user_data``" for callbacks, the ``CLOSURE`` option
- points to a different parameter that is the actual callback.
+ - The parameter is a callback, the ``CLOSURE`` option points to a different
+ parameter that is the "``user_data``" parameter returned by the callback.
-
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]