libweston: Define head, output and compositor group
authorMarius Vlad <marius.vlad@collabora.com>
Mon, 10 Jun 2019 21:05:08 +0000 (00:05 +0300)
committerPekka Paalanen <pq@iki.fi>
Tue, 25 Jun 2019 14:05:54 +0000 (14:05 +0000)
commit78984ee971d227367c26ab27bb3210455523f951
tree690a7c5a09eb90c282fbfb51a1179bc5618a2c72
parentae2634103765fac4a8c8c6ce60e5817760834df1
libweston: Define head, output and compositor group

Also, add tag symbols related to 'weston_head'.

The bridge between sphinx and doxygen (breathe) has a useful directive:
doxygengroup. By using it we can scoop out symbols we'd like to display
documentation from/of.

At the same time some bits of the code has been using '\memberof' (a
doxygen command useful in C code to establish class like
relationship between objects and functions) but this seems not to be
recognized by the sphinx bridge.

Until we find a better solution, we replace '\memberof' command with
'\ingroup' one as to tag the symbols with an "object". This patch does
that for 'weston_head' object.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
include/libweston/libweston.h
libweston/compositor.c