diff options
| author | Yong Bakos <ybakos@humanoriented.com> | 2016-11-20 09:26:08 -0800 |
|---|---|---|
| committer | Daniel Stone <daniels@collabora.com> | 2016-11-21 11:07:54 +0000 |
| commit | 013cfd9408ca7460f62dd1721a057330bd6524a8 (patch) | |
| tree | 67ad57eccf211785f3983a180b447c823af91746 | |
| parent | b4636b5e606177c5a771fcf4349fbf321fdf071c (diff) | |
util: Improve documentation of wl_iterator_result
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>
| -rw-r--r-- | src/wayland-util.h | 6 |
1 files 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 */ |