From 9ac70f4349bfa4f934b96cdff4eaa88d5811b5a5 Mon Sep 17 00:00:00 2001 From: Yong Bakos Date: Sat, 12 Nov 2016 10:11:21 -0800 Subject: util: Improve documentation of wl_argument Standardize the doxygen comment format, add clarity to the writing, decouple the description from specifics of usage, add see-also's, and massage the union member type comments. Signed-off-by: Yong Bakos Reviewed-by: Peter Hutterer Reviewed-by: Pekka Paalanen --- src/wayland-util.h | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/src/wayland-util.h b/src/wayland-util.h index 5e9c411..8b02ff0 100644 --- a/src/wayland-util.h +++ b/src/wayland-util.h @@ -640,22 +640,25 @@ wl_fixed_from_int(int i) } /** - * \brief A union representing all of the basic data types that can be passed - * along the wayland wire format. + * Protocol message argument data types * - * This union represents all of the basic data types that can be passed in the - * wayland wire format. It is used by dispatchers and runtime-friendly - * versions of the event and request marshaling functions. + * This union represents all of the argument types in the Wayland protocol wire + * format. The protocol implementation uses wl_argument within its marshalling + * machinery for dispatching messages between a client and a compositor. + * + * \sa wl_message + * \sa wl_interface + * \sa Wire Format */ union wl_argument { - int32_t i; /**< signed integer */ - uint32_t u; /**< unsigned integer */ - wl_fixed_t f; /**< fixed point */ - const char *s; /**< string */ - struct wl_object *o; /**< object */ - uint32_t n; /**< new_id */ - struct wl_array *a; /**< array */ - int32_t h; /**< file descriptor */ + int32_t i; /**< `int` */ + uint32_t u; /**< `uint` */ + wl_fixed_t f; /**< `fixed` */ + const char *s; /**< `string` */ + struct wl_object *o; /**< `object` */ + uint32_t n; /**< `new_id` */ + struct wl_array *a; /**< `array` */ + int32_t h; /**< `fd` */ }; /** -- cgit v1.2.3