handle: document kdbus_handle.ptr
authorDaniel Mack <daniel@zonque.org>
Wed, 1 Oct 2014 00:10:11 +0000 (02:10 +0200)
committerDaniel Mack <daniel@zonque.org>
Wed, 1 Oct 2014 00:10:11 +0000 (02:10 +0200)
Signed-off-by: Daniel Mack <daniel@zonque.org>
handle.c

index d7457dc7483f7f97f932f93f5dfe960b3222f98b..2a69170f83a8f3709aacdbe30abc060f3c7c690c 100644 (file)
--- a/handle.c
+++ b/handle.c
@@ -66,6 +66,8 @@ enum kdbus_handle_type {
  * @ep:                        The endpoint for this handle, in case @type is
  *                     KDBUS_HANDLE_EP, KDBUS_HANDLE_EP_OWNER or
  *                     KDBUS_HANDLE_EP_CONNECTED
+ * @ptr:               Generic pointer used as alias for other members
+ *                     in the same union by kdbus_handle_transform()
  * @domain_owner:      The domain this handle owns, in case @type
  *                     is KDBUS_HANDLE_CONTROL_DOMAIN_OWNER
  * @bus_owner:         The bus this handle owns, in case @type