[PATCH wayland] wayland-server: hide wl_priv_signal from doxygen

Pekka Paalanen ppaalanen at gmail.com
Fri Jan 27 08:39:32 UTC 2017


On Wed, 25 Jan 2017 06:24:03 -0800
Yong Bakos <junk at humanoriented.com> wrote:

> Hi Pekka,
> 
> > On Jan 25, 2017, at 4:32 AM, Pekka Paalanen <ppaalanen at gmail.com> wrote:
> > 
> > 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>  
> 
> I like the INTERNAL semantics but you can probably just use \cond
> and \endcond alone for consistency, as it is everywhere else. Just
> an opinion.

Hi,

it mostly serves as a comment on why that hunk has been excluded. Makes
it maybe slightly easier to start generating internal-flavour docs if
we ever want to. It's a little different from the deprecated public
stuff, so I think it's ok.

Pushed with your R-b:
   8fe8a2b..56f2dad  master -> master


Thanks,
pq
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 801 bytes
Desc: OpenPGP digital signature
URL: <https://lists.freedesktop.org/archives/wayland-devel/attachments/20170127/3948aabe/attachment.sig>


More information about the wayland-devel mailing list