[PATCH wayland 0/1] doc: Formalize file comment in wayland-client.h, wayland-server.h

[Yong Bakos]

From: Yong Bakos <ybakos at humanoriented.com>

When the -core.h decoupling was introduced, the doc comment at the top of
wayland-server.h ended up being parsed by doxygen as the documentation for 
the deprecated type definition of wl_object. This caused publican to raise an
error during doc generation, and also resulted in wl_object being documented
incorrectly.

This patch squelches the publican error during a build, removes the invalid
documentation of wl_object, and makes the doc comment visible in the html
documentation.

I chose to annotate this with a \warning, since the comment feels more like
a warning and not just a note. Let me know if that is too harsh (visually,
it appears in red, rather than yellow, in the html doc), along with any
other comments.

Yay, one less build warning. (Not that you noticed. :)

Regards,
yong

Yong Bakos (1):
  doc: Formalize file comment in wayland-client.h, wayland-server.h

 src/wayland-client.h | 7 +++++--
 src/wayland-server.h | 9 ++++++---
 2 files changed, 11 insertions(+), 5 deletions(-)

-- 
2.7.2