doc: generate doxygen html output from the scanner

Graphics / Wayland / Wayland - Peter Hutterer [who-t.net] - 7 March 2016 13:55 UTC

This switches the scanner to generate doxygen-compatible tags for the generated protocol headers, and hooks up the doxygen build to generate server and client-side API documentation. That documentation is now in Client/ and Server/, respectively.

GENERATE_HTML is on by default and must be disabled for the xml/man targets to avoid messing up the new documentation. We disable all three three targets in the doxyfile (xml and man default to NO anyway) to make it obvious that they need to be set in the per-target instructions.

Each protocol is a separate doxygen @page, with each interface a @subpage. Wayland only has one protocol, wayland-protocols will have these nested. Each protocol page has a list of interfaces and the copyright and description where available. All interfaces are grouped by doxygen @defgroup and @ingroups and appear in "Modules" in the generated output. Each interface subpage has the description and a link to the actual API doc. Function, struct and #defines are documented in doxygen style and associated with the matching interface.

Note that pages and groups have fixed HTML file names and are directly linkable/bookmark-able.

The @mainpage is a separate file that's included at build time. It doesn't contain much other than links to where the interesting bits are. It's a static file though that supports markdown, so we can extend it easily in the future.

For doxygen we need the new options EXTRACT_ALL and OPTIMIZE_OUTPUT_FOR_C so it scans C code properly. EXTRACT_STATIC is needed since most of the protocol hooks are static.

2b5310a doc: generate doxygen html output from the scanner
doc/doxygen/Makefile.am | 27 ++++-
doc/doxygen/mainpage.dox | 13 +++
doc/doxygen/wayland.doxygen.in | 6 ++
src/scanner.c | 218 ++++++++++++++++++++++++++--------------
4 files changed, 187 insertions(+), 77 deletions(-)

Upstream: cgit.freedesktop.org

  • Share