[PATCH wayland] util: Document wl_fixed_t

Daniel Stone daniel at fooishbar.org
Wed Nov 16 16:35:50 UTC 2016

On 11 November 2016 at 15:55, Yong Bakos <junk at humanoriented.com> wrote:
> From: Yong Bakos <ybakos at humanoriented.com>
> 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 at humanoriented.com>

Pushed with mine and Peter's review, thanks:
To ssh://git.freedesktop.org/git/wayland/wayland
   2c6350b..6a18a87  master -> master


More information about the wayland-devel mailing list