mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-02 09:01:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source 
(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.
Reviewed-by: Jon A. Cruz <jonc@osg.samsung.com>
Tested-by: Jon A. Cruz <jonc@osg.samsung.com>
This commit is contained in:
Bill Spitzak 2015-01-28 18:44:08 -08:00 • committed by Bryce Harrington
parent a4afd90f9f
commit 6be2d9aaef
5 changed files with 154 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

49
doc/publican/doxygen-to-publican.xsl
View file

@ -4,49 +4,16 @@
<xsl:param name="which" />
<xsl:template match="/">
<!-- insert docbook's DOCTYPE blurb -->
<xsl:text disable-output-escaping = "yes"><![CDATA[
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
%BOOK_ENTITIES;
]>
]]></xsl:text>
<xsl:apply-templates select="/doxygen/compounddef[@kind!='file' and @kind!='dir']" />
<appendix id="sect-Library-$which">
<xsl:attribute name="id">sect-Library-<xsl:value-of select="$which"/></xsl:attribute>
<title><xsl:value-of select="$which"/> API</title>
<section id="{$which}-Functions">
<title>Functions</title>
<para />
<variablelist>
<xsl:apply-templates select="/doxygen/compounddef[@kind='file']/sectiondef/memberdef" />
</variablelist>
</section>
<para>
The open-source reference implementation of Wayland protocol is
split in two C libraries, <link
linkend="sect-Library-Client">libwayland-client</link> and <link
linkend="sect-Library-Server">libwayland-server</link>. Their
main responsibility is to handle the Inter-process communication
(<emphasis>IPC</emphasis>) with each other, therefore
guaranteeing the protocol objects marshaling and messages
synchronization.
</para>
<para>
Following is the Wayland library classes for the
<emphasis>libwayland-<xsl:value-of select="translate($which,
'SC', 'sc')"/></emphasis>. This appendix describes in detail
the library's methods and their helpers, aiming implementors who
are building a Wayland <xsl:value-of select="translate($which,
'SC', 'sc')"/>.
</para>
<xsl:apply-templates select="/doxygen/compounddef[@kind!='file' and @kind!='dir']" />
<section id="{$which}-Functions">
<title>Functions</title>
<para />
<variablelist>
<xsl:apply-templates select="/doxygen/compounddef[@kind='file']/sectiondef/memberdef" />
</variablelist>
</section>
</appendix>
</xsl:template>
<xsl:template match="parameteritem">