• Marius Vlad's avatar
    weston-log: Start adding documentation for the logging/debugging framework · 8b8b803a
    Marius Vlad authored
    Adds initial grouping for sphinx/breathe for the logging/debugging
    framework. We add a few groups: log (public API), internal-log (private API,
    not exported) and debug-protocol, specific to the weston
    debug protocol.
    
    In latest version of breathe, '\memberof' command is recognized as such.
    But it conflicts with '\ingroup' command and can't be used in the same
    time (leading to duplicate symbols), so we follow a simple rule: object
    tagging with '\ingroup' then use '\memberof' command for the functions
    that work on that object.
    
    There's also a caveat here: we have objects that are private (opaque)
    but the functions are public. For those cases we resort to using
    'internal-log' for the object (class) and 'log' for the functions.
    Signed-off-by: Marius Vlad's avatarMarius Vlad <marius.vlad@collabora.com>
    8b8b803a
Name
Last commit
Last update
.gitlab-ci Loading commit data...
clients Loading commit data...
compositor Loading commit data...
data Loading commit data...
desktop-shell Loading commit data...
doc Loading commit data...
fullscreen-shell Loading commit data...
include Loading commit data...
ivi-shell Loading commit data...
libweston Loading commit data...
libweston-desktop Loading commit data...
man Loading commit data...
protocol Loading commit data...
remoting Loading commit data...
shared Loading commit data...
tests Loading commit data...
tools/zunitc Loading commit data...
wcap Loading commit data...
xwayland Loading commit data...
.editorconfig Loading commit data...
.gitignore Loading commit data...
.gitlab-ci.yml Loading commit data...
CONTRIBUTING.md Loading commit data...
COPYING Loading commit data...
DCO-1.1.txt Loading commit data...
README.md Loading commit data...
meson.build Loading commit data...
meson_options.txt Loading commit data...
notes.txt Loading commit data...
releasing.txt Loading commit data...
weston.ini.in Loading commit data...