util: Document wl_fixed_t
authorYong Bakos <ybakos@humanoriented.com>
Fri, 11 Nov 2016 15:55:38 +0000 (07:55 -0800)
committerDaniel Stone <daniels@collabora.com>
Wed, 16 Nov 2016 16:35:18 +0000 (16:35 +0000)
commitfd75029fb9e0c5678914f5046809ab047cf7583c
treee343042bc2a332d786359560d4b293cbd747b02a
parent2281bc08b2be2eb07c169fc283dc1e16f99bf346
util: Document wl_fixed_t

Add doxygen comments for wl_fixed_t and its methods.

Although wl_fixed_t can be thought of as an opaque struct, it is a typedef. As
such, doxygen does not provide an elegant means of documenting it as both a
'class' with members and as a typedef. In other words, documenting it as a class
gives us a nice doxygen page for wl_fixed_t and its related methods, but this
leaves the typedef documentation blank in the documentation for wayland-util,
and does not provide a link to the documentation for wl_fixed_t. Hence, this
patch does not treat wl_fixed_t as a class/struct, resulting in the typedef
being documented and keeping the functions listed in wayland-util, rather than a
separate unlinked page devoted to just wl_fixed_t.

Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Daniel Stone <daniels@collabora.com>
src/wayland-util.h