server: Add doxygen comment for wl_client_for_each

Commit 596024f728b0a1292ee69a80dd72a85167870936 includes a doc comment
with a link to the wl_client_for_each macro, causing an error when generating
documentation.

Add a doc comment to wl_client_for_each, enabling the hyperlink and removing
the error.

Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>

diff --git a/src/wayland-server-core.h b/src/wayland-server-core.h
index 21465af..2c215e4 100644 (file)
--- a/src/wayland-server-core.h
+++ b/src/wayland-server-core.h
@@ -180,6 +180,7 @@ wl_client_get_link(struct wl_client *client);
 struct wl_client *
 wl_client_from_link(struct wl_list *link);
 
+/** Iterate over a list of clients. */
 #define wl_client_for_each(client, list)                               \
        for (client = wl_client_from_link((list)->next);        \
             wl_client_get_link(client) != (list);                      \