doc: Intro text for doxygen output in it's own file

Graphics / Wayland / Wayland - Bill Spitzak [gmail.com] - 29 January 2015 19:13 UTC

(This patch has been modified to apply atop current master)

This makes it considerably easier to edit the text and make it different for each library.

To address previous concerns with this patch, I wrote some more complete introductory text. This is based on my understanding of these libraries, which may not be correct, and is pretty rudimentary for libwayland-server!

However this intro text demonstrates how to create links to the doxygen-generated text. It looks like you cannot link to methods easily as the link name contains a hash number, but links to objects and classes work.

6be2d9a doc: Intro text for doxygen output in it's own file
doc/publican/Makefile.am | 4 +-
doc/publican/doxygen-to-publican.xsl | 51 ++++---------------
doc/publican/sources/Client.xml | 92 ++++++++++++++++++++++++++++++++++
doc/publican/sources/Server.xml | 49 ++++++++++++++++++
doc/publican/sources/Wayland.xml | 5 +-
5 files changed, 155 insertions(+), 46 deletions(-)

Upstream: cgit.freedesktop.org


  • Share