doc: improve formatting of client-side documentation
authorPeter Hutterer <peter.hutterer@who-t.net>
Tue, 2 Apr 2013 00:09:11 +0000 (10:09 +1000)
committerKristian Høgsberg <krh@bitplanet.net>
Wed, 3 Apr 2013 19:44:49 +0000 (15:44 -0400)
commitb17e5e1615a17f6cb3f5112a822d6f3f07738095
treeb09e2f164085d86e4de08f0be6e1493ba9eb6d74
parent378caae828afeb4075a1e98db1d1eaca489a58d5
doc: improve formatting of client-side documentation

A bunch of changes to the xsl transformation stylesheet to make Chapter 4
(Client API) look nicer and more readable.

Main changes:
- function synopsis listed
- lists for parameters and return values
- long function descriptions
- misc other hooks for "see also", "note", etc

The long description is a sore point. doxygen xml output is difficult to
parse with the output being in the form of
<detailed description>
  <para>
   <parameterlist> .... </parameterlist>
<simplesect kind="return">... </simplesect>
First paragraph of long description
  </para>
  <para>
   Second paragraph of long <sometag>description</sometag>
  </para>
</detaileddescription>

So we need to ignore parameterlist and simplesect, but extract the text from
everything else. Any improvements on that welcome.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
doc/Wayland/doxygen-to-publican.xsl