diff options
| author | Yong Bakos <ybakos@humanoriented.com> | 2016-11-12 10:11:21 -0800 |
|---|---|---|
| committer | Pekka Paalanen <pekka.paalanen@collabora.co.uk> | 2016-11-18 17:10:21 +0200 |
| commit | 9ac70f4349bfa4f934b96cdff4eaa88d5811b5a5 (patch) | |
| tree | dd06190494cb6ab8dcff7f160f10cb6792e9afae | |
| parent | 2d328a4559152ed11e52bdbd85689d7b2239596a (diff) | |
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 <ybakos@humanoriented.com>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
| -rw-r--r-- | src/wayland-util.h | 29 |
1 files 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 <a href="https://wayland.freedesktop.org/docs/html/ch04.html#sect-Protocol-wire-Format">Wire Format</a> */ 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` */ }; /** |