[PATCH weston 02/15] libweston: untangle weston_compositor_remove_output doc

[Pekka Paalanen]

On Tue, 4 Apr 2017 21:30:04 +0200
Armin Krezović <krezovic.armin at gmail.com> wrote:

> On 04.04.2017 12:58, Pekka Paalanen wrote:
> > From: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
> > 
> > Trying to make it more readable. Things that happen in the same step are
> > kept in the same paragraph.
> > 
> > Signed-off-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
> > ---
> >  libweston/compositor.c | 24 ++++++++++++++++--------
> >  1 file changed, 16 insertions(+), 8 deletions(-)
> > 
> > diff --git a/libweston/compositor.c b/libweston/compositor.c
> > index 2bca19c..7510fab 100644
> > --- a/libweston/compositor.c
> > +++ b/libweston/compositor.c
> > @@ -4516,18 +4516,26 @@ weston_output_enable_undo(struct weston_output *output)
> >  	output->enabled = false;
> >  }
> >  
> > -/** Removes output from compositor's output list
> > +/** Removes output from compositor's live outputs list  
> 
> live -> enabled? Also, there's pending output list and just output list.
> Not sure if the latter could use some renaming (probably not), to avoid
> any further confusion?

Ok, I'll start using "list of enabled outputs" to refer to output_list.

> >   *
> >   * \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
> > + * The following happens:
> > + *
> > + * - The output assignments of all views in the current scenegraph are
> > + * recomputed.  
> 
> Minor nit: If you are going to use -, make sure lines that are broken up
> are aligned. Not a big deal, though.

Hmm, never crossed my mind to indent more. Let's hope doxygen knows to
drop the whitespace.

> > + *
> > + * - 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
> > + * All views assigned to the weston_output object are
> > + * moved to a new output by the shell, if necessary.
> > + *  
> 
> Is this really worth mentioning? shell is, after all, an user of the output.
> It does not have to be this way. fullscreen-shell doesn't do any moving, for
> example. It just nukes the output. But still, if this belongs here, did you
> forget - in the beginning of the line? Or is it part of "Signal is emitted..."?

That is what I thought the original comment was vaguely referring to.
It's wasn't?

I can drop that.


Thanks,
pq


> > + * - wl_output protocol objects referencing this weston_output
> >   * are made inert.
> >   */
> >  static void
> >   
> 
> Cheers. Armin.
> 

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <https://lists.freedesktop.org/archives/wayland-devel/attachments/20170411/f8f567c1/attachment.sig>