On Sun, Nov 20, 2016 at 09:26:08AM -0800, Yong Bakos wrote: > From: Yong Bakos <[email protected]> > > Use declarative voice, remove the unnecessary doxygen \enum tag, and add > two see-also's. This keeps the output the same but makes the comment > voice consistent, a little more readable, and refers to documented > functions that use this enum type. > > Signed-off-by: Yong Bakos <[email protected]>
Reviewed-by: Peter Hutterer <[email protected]> Cheers, Peter > --- > src/wayland-util.h | 6 ++++-- > 1 file changed, 4 insertions(+), 2 deletions(-) > > diff --git a/src/wayland-util.h b/src/wayland-util.h > index 8b02ff0..2fd99a0 100644 > --- a/src/wayland-util.h > +++ b/src/wayland-util.h > @@ -684,9 +684,11 @@ typedef int (*wl_dispatcher_func_t)(const void *, void > *, uint32_t, > > typedef void (*wl_log_func_t)(const char *, va_list) WL_PRINTF(1, 0); > > -/** \enum wl_iterator_result > +/** > + * Return value of an iterator function > * > - * This enum represents the return value of an iterator function. > + * \sa wl_client_for_each_resource_iterator_func_t > + * \sa wl_client_for_each_resource > */ > enum wl_iterator_result { > /** Stop the iteration */ > -- > 2.7.2 > > _______________________________________________ > wayland-devel mailing list > [email protected] > https://lists.freedesktop.org/mailman/listinfo/wayland-devel > _______________________________________________ wayland-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/wayland-devel
