libweston: Add ingroup tag for weston_compositor
This is a continuation of "e2cc7aa40fd: libweston: Define head, output and
compositor group".
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
diff --git a/libweston/compositor.c b/libweston/compositor.c
index 2e84e45..a99deed 100644
--- a/libweston/compositor.c
+++ b/libweston/compositor.c
@@ -1864,12 +1864,18 @@
surface_set_size(surface, width, height);
}
+/** weston_compositor_get_time
+ * \ingroup compositor
+ */
WL_EXPORT void
weston_compositor_get_time(struct timespec *time)
{
clock_gettime(CLOCK_REALTIME, time);
}
+/** weston_compositor_pick_view
+ * \ingroup compositor
+ */
WL_EXPORT struct weston_view *
weston_compositor_pick_view(struct weston_compositor *compositor,
wl_fixed_t x, wl_fixed_t y,
@@ -2223,6 +2229,9 @@
weston_presentation_feedback_discard_list(&surface->feedback_list);
}
+/** weston_compositor_damage_all
+ * \ingroup compositor
+ */
WL_EXPORT void
weston_compositor_damage_all(struct weston_compositor *compositor)
{
@@ -2935,6 +2944,9 @@
TL_POINT("core_repaint_enter_loop", TLP_OUTPUT(output), TLP_END);
}
+/** weston_compositor_schedule_repaint
+ * \ingroup compositor
+ */
WL_EXPORT void
weston_compositor_schedule_repaint(struct weston_compositor *compositor)
{
@@ -4460,6 +4472,7 @@
* signal will fire.
*
* Restarts the idle timer.
+ * \ingroup compositor
*/
WL_EXPORT void
weston_compositor_wake(struct weston_compositor *compositor)
@@ -4492,6 +4505,8 @@
* compositor is shutting down.
*
* Stops the idle timer.
+ *
+ * \ingroup compositor
*/
WL_EXPORT void
weston_compositor_offscreen(struct weston_compositor *compositor)
@@ -4515,6 +4530,8 @@
* in sleep mode.
*
* Stops the idle timer.
+ *
+ * \ingroup compositor
*/
WL_EXPORT void
weston_compositor_sleep(struct weston_compositor *compositor)
@@ -4585,6 +4602,9 @@
wl_list_remove(&plane->link);
}
+/** weston_compositor_stack_plane
+ * \ingroup compositor
+ */
WL_EXPORT void
weston_compositor_stack_plane(struct weston_compositor *ec,
struct weston_plane *plane,
@@ -4774,7 +4794,7 @@
*
* \param compositor The Compositor.
*
- * \memberof weston_compositor
+ * \ingroup compositor
* \internal
*/
static void
@@ -4798,7 +4818,7 @@
* This signals the core that a new head has become available, leading to
* heads_changed hook being called later.
*
- * \memberof weston_compositor
+ * \ingroup compositor
* \internal
*/
WL_EXPORT void
@@ -4827,7 +4847,7 @@
*
* \sa weston_compositor_iterate_heads, weston_head_is_connected,
* weston_head_is_enabled
- * \memberof weston_compositor
+ * \ingroup compositor
*/
WL_EXPORT void
weston_compositor_add_heads_changed_listener(struct weston_compositor *compositor,
@@ -4856,7 +4876,7 @@
* If you cause \c iter to be removed from the list, you cannot use it to
* continue iterating. Removing any other item is safe.
*
- * \memberof weston_compositor
+ * \ingroup compositor
*/
WL_EXPORT struct weston_head *
weston_compositor_iterate_heads(struct weston_compositor *compositor,
@@ -5567,6 +5587,7 @@
* \param output The output to be added.
*
* \internal
+ * \ingroup compositor
*/
static void
weston_compositor_add_output(struct weston_compositor *compositor,
@@ -5656,7 +5677,7 @@
*
* - The output's internal ID is released.
*
- * \memberof weston_output
+ * \ingroup compositor
* \internal
*/
static void
@@ -5839,7 +5860,7 @@
*
* The opposite of this operation is built into weston_output_release().
*
- * \ingroup output
+ * \ingroup compositor
* \internal
*/
WL_EXPORT void
@@ -6052,6 +6073,8 @@
*
* If there are new or changed heads, calls the heads_changed hook and
* returns after the hook returns.
+ *
+ * \ingroup compositor
*/
WL_EXPORT void
weston_compositor_flush_heads_changed(struct weston_compositor *compositor)
@@ -6151,7 +6174,7 @@
* \param name The output name to search for.
* \return An existing output with the given name, or NULL if not found.
*
- * \memberof weston_compositor
+ * \ingroup compositor
*/
WL_EXPORT struct weston_output *
weston_compositor_find_output_by_name(struct weston_compositor *compositor,
@@ -6181,7 +6204,7 @@
* An output must be configured and it must have at least one head before
* it can be enabled.
*
- * \memberof weston_compositor
+ * \ingroup compositor
*/
WL_EXPORT struct weston_output *
weston_compositor_create_output(struct weston_compositor *compositor,
@@ -6210,7 +6233,7 @@
*
* An output must be configured before it can be enabled.
*
- * \memberof weston_compositor
+ * \ingroup compositor
*/
WL_EXPORT struct weston_output *
weston_compositor_create_output_with_head(struct weston_compositor *compositor,
@@ -6727,6 +6750,8 @@
/**
* Output information on how libweston is currently composing the scene
* graph.
+ *
+ * \ingroup compositor
*/
WL_EXPORT char *
weston_compositor_print_scene_graph(struct weston_compositor *ec)
@@ -6835,6 +6860,8 @@
* \param log_ctx A pointer to weston_debug_compositor
* using the \ref weston_compositor_get_user_data function.
* \return The compositor instance on success or NULL on failure.
+ *
+ * \ingroup compositor
*/
WL_EXPORT struct weston_compositor *
weston_compositor_create(struct wl_display *display,
@@ -6951,6 +6978,9 @@
return NULL;
}
+/** weston_compositor_shutdown
+ * \ingroup compositor
+ */
WL_EXPORT void
weston_compositor_shutdown(struct weston_compositor *ec)
{
@@ -6979,8 +7009,11 @@
weston_plane_release(&ec->primary_plane);
}
+/** weston_compositor_exit_with_code
+ * \ingroup compositor
+ */
WL_EXPORT void
-weston_compositor_exit_with_code(struct weston_compositor *compositor,
+weston_compositor_exit_with_code(struct weston_compositor *compositor,
int exit_code)
{
if (compositor->exit_code == EXIT_SUCCESS)
@@ -6989,6 +7022,9 @@
weston_compositor_exit(compositor);
}
+/** weston_compositor_set_default_pointer_grab
+ * \ingroup compositor
+ */
WL_EXPORT void
weston_compositor_set_default_pointer_grab(struct weston_compositor *ec,
const struct weston_pointer_grab_interface *interface)
@@ -7004,6 +7040,9 @@
}
}
+/** weston_compositor_set_presentation_clock
+ * \ingroup compositor
+ */
WL_EXPORT int
weston_compositor_set_presentation_clock(struct weston_compositor *compositor,
clockid_t clk_id)
@@ -7018,9 +7057,10 @@
return 0;
}
-/*
- * For choosing the software clock, when the display hardware or API
+/** For choosing the software clock, when the display hardware or API
* does not expose a compatible presentation timestamp.
+ *
+ * \ingroup compositor
*/
WL_EXPORT int
weston_compositor_set_presentation_clock_software(
@@ -7057,6 +7097,8 @@
* This function is never meant to fail. If reading the clock does fail,
* an error message is logged and a zero time is returned. Callers are not
* supposed to detect or react to failures.
+ *
+ * \ingroup compositor
*/
WL_EXPORT void
weston_compositor_read_presentation_clock(
@@ -7093,7 +7135,9 @@
* This hook is also used for detecting if the renderer supports
* dmabufs at all. If the renderer hook is NULL, dmabufs are not
* supported.
- * */
+ *
+ * \ingroup compositor
+ */
WL_EXPORT bool
weston_compositor_import_dmabuf(struct weston_compositor *compositor,
struct linux_dmabuf_buffer *buffer)
@@ -7222,6 +7266,8 @@
* This function cleans up the compositor state and destroys it.
*
* \param compositor The compositor to be destroyed.
+ *
+ * \ingroup compositor
*/
WL_EXPORT void
weston_compositor_destroy(struct weston_compositor *compositor)
@@ -7258,6 +7304,8 @@
* tear down will happen immediately.
*
* \param compositor The compositor to tear down.
+ *
+ * \ingroup compositor
*/
WL_EXPORT void
weston_compositor_exit(struct weston_compositor *compositor)
@@ -7269,6 +7317,8 @@
*
* This function returns the user data pointer set with user_data parameter
* to the \ref weston_compositor_create function.
+ *
+ * \ingroup compositor
*/
WL_EXPORT void *
weston_compositor_get_user_data(struct weston_compositor *compositor)
@@ -7296,6 +7346,8 @@
* structure's 'base' member.
*
* \return 0 on success, or -1 on error.
+ *
+ * \ingroup compositor
*/
WL_EXPORT int
weston_compositor_load_backend(struct weston_compositor *compositor,
@@ -7325,6 +7377,9 @@
return 0;
}
+/** weston_compositor_load_xwayland
+ * \ingroup compositor
+ */
WL_EXPORT int
weston_compositor_load_xwayland(struct weston_compositor *compositor)
{