mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-03-15 05:34:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

util: Improve documentation of wl_argument

Browse source 
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>
This commit is contained in:
Yong Bakos 2016-11-12 10:11:21 -08:00 • committed by Pekka Paalanen
parent 2d328a4559
commit 9ac70f4349
1 changed files with 16 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

29
src/wayland-util.h
View file

@ -640,22 +640,25 @@ wl_fixed_from_int(int i)
} }
/** /**
* \brief A union representing all of the basic data types that can be passed * Protocol message argument data types
* along the wayland wire format.
* *
* This union represents all of the basic data types that can be passed in the * This union represents all of the argument types in the Wayland protocol wire
* wayland wire format. It is used by dispatchers and runtime-friendly * format. The protocol implementation uses wl_argument within its marshalling
* versions of the event and request marshaling functions. * 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 { union wl_argument {
int32_t i; /**< signed integer */ int32_t i; /**< `int` */
uint32_t u; /**< unsigned integer */ uint32_t u; /**< `uint` */
wl_fixed_t f; /**< fixed point */ wl_fixed_t f; /**< `fixed` */
const char *s; /**< string */ const char *s; /**< `string` */
struct wl_object *o; /**< object */ struct wl_object *o; /**< `object` */
uint32_t n; /**< new_id */ uint32_t n; /**< `new_id` */
struct wl_array *a; /**< array */ struct wl_array *a; /**< `array` */
int32_t h; /**< file descriptor */ int32_t h; /**< `fd` */
}; };
/** /**