Commit 013cfd94 authored by Yong Bakos's avatar Yong Bakos Committed by Daniel Stone

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: 's avatarYong Bakos <ybakos@humanoriented.com>
Reviewed-by: Peter Hutterer's avatarPeter Hutterer <peter.hutterer@who-t.net>
parent b4636b5e
......@@ -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 */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment