[PATCH wayland] wayland-server: hide wl_priv_signal from doxygen
Pekka Paalanen
ppaalanen at gmail.com
Wed Jan 25 12:32:02 UTC 2017
From: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
Fix this set of warnings appearing three times during a build:
/home/pq/git/wayland/src/wayland-server.c:1868: warning: class
`wl_priv_signal' for related function `wl_priv_signal_init' is not
documented.
/home/pq/git/wayland/src/wayland-server.c:1884: warning: class
`wl_priv_signal' for related function `wl_priv_signal_add' is not
documented.
/home/pq/git/wayland/src/wayland-server.c:1899: warning: class
`wl_priv_signal' for related function `wl_priv_signal_get' is not
documented.
Our Wayland docbook don't include private things, so make sure these do
not end up there. This removes the mention of wl_priv_signal_emit from
the Server API docbook. I have no idea why the other functions did not
appear there.
Signed-off-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
---
src/wayland-server.c | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/src/wayland-server.c b/src/wayland-server.c
index ac634da..f27ed3f 100644
--- a/src/wayland-server.c
+++ b/src/wayland-server.c
@@ -1852,6 +1852,8 @@ wl_client_for_each_resource(struct wl_client *client,
wl_map_for_each(&client->objects, resource_iterator_helper, &context);
}
+/** \cond INTERNAL */
+
/** Initialize a wl_priv_signal object
*
* wl_priv_signal is a safer implementation of a signal type, with the same API
@@ -1943,6 +1945,8 @@ wl_priv_signal_emit(struct wl_priv_signal *signal, void *data)
}
}
+/** \endcond INTERNAL */
+
/** \cond */ /* Deprecated functions below. */
uint32_t
--
2.10.2
More information about the wayland-devel
mailing list