doc: generate man pages from doxygen
authorPeter Hutterer <peter.hutterer@who-t.net>
Tue, 2 Apr 2013 01:08:59 +0000 (11:08 +1000)
committerKristian Høgsberg <krh@bitplanet.net>
Wed, 3 Apr 2013 19:44:50 +0000 (15:44 -0400)
commit8ccab1ba621c299b8cedbc6ac1c673967febf316
tree11d44c7a3125494c876bdf79bf4ce00362bdf6b2
parente5202f76b001d7db21d313bda197e88b11cbe7d0
doc: generate man pages from doxygen

Create client-side and server-side man pages from doxygen. The doxygen
config options are virtually the same as for the XML output, but we do pass
in the specific options via stdin.

WL_EXPORT is predefined to the empty string, it makes the man page look
confusing and provides no value here anyway. This applies for both xml and
man output.

JAVADOC_AUTOBRIEF is disabled for man pages, the formatting in the resulting
man page is IMO hard to read.

Most of the server man pages are virtually empty, there's just not enough
documentation in the source files.

Interesting issue: the usage of @code in the protocol to reference the
parameter breaks the expansion of WL_EXPORT, thus leaving us with WL_EXPORT
in all the man pages.
Presumably this is an issue with doxygen interpreting this as a @code
command, but I already wasted enough time narrowing this down.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
doc/doxygen/Makefile.am
doc/doxygen/wayland.doxygen.in