From e6ac4fcbc93a5e754c5d64de7e0b939374a09715 Mon Sep 17 00:00:00 2001 From: Pekka Paalanen Date: Wed, 29 Mar 2017 16:07:34 +0300 Subject: [PATCH] libweston: untangle weston_compositor_remove_output doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Trying to make it more readable. Things that happen in the same step are kept in the same paragraph. v2: talk about "list of enabled outputs" Signed-off-by: Pekka Paalanen Reviewed-by: Armin Krezović --- libweston/compositor.c | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/libweston/compositor.c b/libweston/compositor.c index 2a3074db..65b3de20 100644 --- a/libweston/compositor.c +++ b/libweston/compositor.c @@ -4521,19 +4521,25 @@ weston_output_enable_undo(struct weston_output *output) output->enabled = false; } -/** Removes output from compositor's output list +/** Removes output from compositor's list of enabled outputs * * \param output The weston_output object that is being removed. * - * Presentation feedback is discarded. - * Compositor is notified that outputs were changed and - * applies the necessary changes. - * All views assigned to the weston_output object are - * moved to a new output. - * Signal is emitted to notify all users of the weston_output - * object that the output is being destroyed. - * wl_output protocol objects referencing this weston_output - * are made inert. + * The following happens: + * + * - The output assignments of all views in the current scenegraph are + * recomputed. + * + * - Presentation feedback is discarded. + * + * - Compositor is notified that outputs were changed and + * applies the necessary changes to re-layout outputs. + * + * - Signal is emitted to notify all users of the weston_output + * object that the output is being destroyed. + * + * - wl_output protocol objects referencing this weston_output + * are made inert. */ static void weston_compositor_remove_output(struct weston_output *output)