Skip to content
Commit e5b12aa8 authored by Yong Bakos's avatar Yong Bakos Committed by Bryce Harrington
Browse files

doc: Formalize file comment in wayland-client.h, wayland-server.h



Publican was generating a subtle error during a build:
Error: no ID for constraint linkend: Server-wayland-server-core_8h.

This was caused by doxygen applying the doc comment at the top of
wayland-server.h as the documentation for struct wl_object. As such, the
generated documentation for wl_object was also very incorrect.

Make the file doc comments in wayland-client.h and wayland-server.h real
doxygen file doc comments with the \file command, add a \brief, make the
inclusion warning a \warning, correct the language of the comment in
wayland-server.h, and remove one unnecessary line break.

This squelches the publican error, removes the bad wl_object documentation,
and makes the comment appear in the generated html documentation.

References: d74a9c07

Signed-off-by: default avatarYong Bakos <ybakos@humanoriented.com>
Reviewed-by: default avatarBryce Harrington <bryce@osg.samsung.com>
parent c6d204fd
Loading
Loading
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment