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: Auto-generate API methods and classes documentation

Browse source 
There's work to do still for giving a prettier style on the documentation, for
instance splitting paragraphs correctly and printing the detailed description
of the methods as well.

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
This commit is contained in:
Tiago Vignatti 2012-11-09 20:14:31 -02:00
parent a95aba7fca
commit c77ba6bebc
2 changed files with 52 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

54
doc/Wayland/doxygen-to-publican.xsl
View file

@ -13,12 +13,20 @@
<section id="sect-Library-Client">
<title>Client API</title>
<para>Following is the Wayland library interface for clients
<para>Following is the Wayland library classes for clients
(<emphasis>libwayland-client</emphasis>). Note that most of the
procedures are related with IPC, which is the main responsibility of
the library.
</para>
<para>
<variablelist>
<xsl:apply-templates select="/doxygen/compounddef" />
</variablelist>
</para>
<para>And methods for the respective classes.</para>
<para>
<variablelist>
<xsl:apply-templates select="/doxygen/compounddef/sectiondef/memberdef" />
@ -27,20 +35,38 @@
</section>
</xsl:template>
<xsl:template match="memberdef" >
<xsl:if test="@kind = 'function'">
<varlistentry>
<term>
<xsl:value-of select="name" />
</term>
<listitem>
<para>
<xsl:value-of select="briefdescription" />
</para>
</listitem>
</varlistentry>
</xsl:if>
<!-- methods -->
<xsl:template match="memberdef" >
<xsl:if test="@kind = 'function' and @static = 'no'">
<varlistentry>
<term>
<xsl:value-of select="name" />
- <xsl:value-of select="briefdescription" />
</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</xsl:if>
</xsl:template>
<!-- classes -->
<xsl:template match="compounddef" >
<xsl:if test="@kind = 'class' ">
<varlistentry>
<term>
<xsl:value-of select="compoundname" />
<xsl:if test="briefdescription">
- <xsl:value-of select="briefdescription" />
</xsl:if>
</term>
<!-- TODO: the output text is not splitting paragraphs correctly -->
<listitem>
<para><xsl:value-of select="detaileddescription"/></para>
</listitem>
</varlistentry>
</xsl:if>
</xsl:template>
</xsl:stylesheet>