[glib: 1/2] gdbusconnection: Clarify nullability in a documentation comment
- From: Sebastian Dröge <sdroege src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib: 1/2] gdbusconnection: Clarify nullability in a documentation comment
- Date: Tue, 22 Oct 2019 07:48:40 +0000 (UTC)
commit b649946c00a6bb7fe8b8f04721459c7d9aa029ac
Author: Philip Withnall <withnall endlessm com>
Date: Tue Jul 23 11:34:59 2019 +0100
gdbusconnection: Clarify nullability in a documentation comment
The comment previously said ‘never %NULL’, but it wasn’t clear whether
this meant `(not nullable)` or `(not optional)`. From looking at the
code, it means `(not optional)`.
Clarify things by removing the prose. The annotations themselves should
be clear and explicit enough.
Signed-off-by: Philip Withnall <withnall endlessm com>
Closes: #1836
gio/gdbusconnection.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
---
diff --git a/gio/gdbusconnection.h b/gio/gdbusconnection.h
index c37363c0d..f7f08a3cc 100644
--- a/gio/gdbusconnection.h
+++ b/gio/gdbusconnection.h
@@ -489,7 +489,7 @@ typedef GDBusInterfaceInfo ** (*GDBusSubtreeIntrospectFunc) (GDBusConnection
* @object_path: The object path that was registered with g_dbus_connection_register_subtree().
* @interface_name: The D-Bus interface name that the method call or property access is for.
* @node: A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the
subtree.
- * @out_user_data: (nullable) (not optional): Return location for user data to pass to functions in the
returned #GDBusInterfaceVTable (never %NULL).
+ * @out_user_data: (nullable) (not optional): Return location for user data to pass to functions in the
returned #GDBusInterfaceVTable.
* @user_data: The @user_data #gpointer passed to g_dbus_connection_register_subtree().
*
* The type of the @dispatch function in #GDBusSubtreeVTable.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]