mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-10-29 05:40:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

util: Improve documentation of wl_iterator_result

Browse source 
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 <ybakos@humanoriented.com>
Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Yong Bakos 2016-11-20 09:26:08 -08:00 • committed by Daniel Stone
parent b4636b5e60
commit 013cfd9408
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/wayland-util.h
View file

@ -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 */