aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/StudioIntegration
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-04-23 15:08:32 +0000
committerDean Camera <dean@fourwalledcubicle.com>2013-04-23 15:08:32 +0000
commitcf8ec8967eab1e3fbaf096d6a44aa8c389ee1532 (patch)
tree50fbde0f0f179d34711bb113bb3ebf98ee965705 /LUFA/StudioIntegration
parentf515e8412f1d2f3e99603d552246a9c894735a79 (diff)
downloadlufa-cf8ec8967eab1e3fbaf096d6a44aa8c389ee1532.tar.gz
lufa-cf8ec8967eab1e3fbaf096d6a44aa8c389ee1532.tar.bz2
lufa-cf8ec8967eab1e3fbaf096d6a44aa8c389ee1532.zip
Move all Doxygen-to-Docbook rules into a single transform, remove redundant rules/transforms and add support for verbatim and linebreak elements.
Diffstat (limited to 'LUFA/StudioIntegration')
-rw-r--r--LUFA/StudioIntegration/Blob/LUFA.dllbin381952 -> 381952 bytes
-rw-r--r--LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl431
-rw-r--r--LUFA/StudioIntegration/HV1/transform_base.xsl823
3 files changed, 339 insertions, 915 deletions
diff --git a/LUFA/StudioIntegration/Blob/LUFA.dll b/LUFA/StudioIntegration/Blob/LUFA.dll
index 2a23ed65d..1146cbadd 100644
--- a/LUFA/StudioIntegration/Blob/LUFA.dll
+++ b/LUFA/StudioIntegration/Blob/LUFA.dll
Binary files differ
diff --git a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl
index dbbc64bd3..c51944ba9 100644
--- a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl
+++ b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
- <xsl:import href="transform_base.xsl"/>
<xsl:output method="xml" indent="no"/>
@@ -87,23 +86,32 @@
<xsl:template name="generate.top.level.page">
<xsl:param name="top.level.page"/>
+
<chapter id="{$top.level.page/@id}">
<title>
<xsl:value-of select="$top.level.page/title"/>
</title>
+
<xsl:apply-templates select="$top.level.page/detaileddescription"/>
+
<xsl:for-each select="$top.level.page/innerpage">
<xsl:apply-templates select="ancestor::*/compounddef[@kind = 'page' and @id = current()/@refid]"/>
</xsl:for-each>
</chapter>
</xsl:template>
+ <xsl:template match="compounddef">
+ <!-- Discard compounddef elements unless a later template matches -->
+ </xsl:template>
+
<xsl:template match="compounddef[@kind = 'page']">
<section id="{@id}">
<title>
<xsl:value-of select="title"/>
</title>
+
<xsl:apply-templates select="detaileddescription"/>
+
<xsl:for-each select="innerpage">
<xsl:apply-templates select="ancestor::*/compounddef[@kind = 'page' and @id = current()/@refid]"/>
</xsl:for-each>
@@ -246,7 +254,7 @@
<section id="{@id}" xreflabel="{name}">
<title>
<xsl:text>Function </xsl:text>
- <xsl:value-of select="name"/>
+ <xsl:value-of select="$name"/>
<xsl:text>()</xsl:text>
</title>
@@ -262,30 +270,30 @@
<programlisting language="c">
<emphasis role="keyword">
- <xsl:value-of select="type"/>
+ <xsl:value-of select="type"/>
</emphasis>
- <xsl:text> </xsl:text>
+ <xsl:text> </xsl:text>
<xsl:value-of select="name"/>
<xsl:text>(</xsl:text>
<xsl:choose>
- <xsl:when test="argsstring = '(void)'">
- <emphasis role="keyword">void</emphasis>
- </xsl:when>
-
- <xsl:otherwise>
- <xsl:for-each select="param">
- <xsl:if test="position() > 1">
- <xsl:text>,</xsl:text>
- </xsl:if>
- <xsl:text>&#10;&#9;&#9;</xsl:text>
- <emphasis role="keyword">
- <xsl:value-of select="type"/>
- </emphasis>
- <xsl:text> </xsl:text>
- <xsl:value-of select="declname"/>
- </xsl:for-each>
- </xsl:otherwise>
+ <xsl:when test="argsstring = '(void)'">
+ <emphasis role="keyword">void</emphasis>
+ </xsl:when>
+
+ <xsl:otherwise>
+ <xsl:for-each select="param">
+ <xsl:if test="position() > 1">
+ <xsl:text>,</xsl:text>
+ </xsl:if>
+ <xsl:text>&#10;&#9;&#9;</xsl:text>
+ <emphasis role="keyword">
+ <xsl:value-of select="type"/>
+ </emphasis>
+ <xsl:text> </xsl:text>
+ <xsl:value-of select="declname"/>
+ </xsl:for-each>
+ </xsl:otherwise>
</xsl:choose>
<xsl:text>)</xsl:text>
@@ -301,7 +309,7 @@
<section id="{@id}" xreflabel="{name}">
<title>
<xsl:text>Enum </xsl:text>
- <xsl:value-of select="name"/>
+ <xsl:value-of select="$name"/>
</title>
<xsl:call-template name="generate.index.id">
@@ -325,6 +333,7 @@
<entry>
<para id="{@id}" xreflabel="{name}">
<xsl:value-of select="name"/>
+ <indexterm id="{$keyword.namespace}.{$name}.{name}"/>
</para>
</entry>
<entry>
@@ -422,11 +431,11 @@
</xsl:call-template>
<programlisting language="c">
- <emphasis role="keyword">
- <xsl:value-of select="type"/>
- </emphasis>
- <xsl:text> </xsl:text>
- <xsl:value-of select="name"/>
+ <emphasis role="keyword">
+ <xsl:value-of select="type"/>
+ </emphasis>
+ <xsl:text> </xsl:text>
+ <xsl:value-of select="name"/>
</programlisting>
</xsl:otherwise>
</xsl:choose>
@@ -436,7 +445,305 @@
</xsl:template>
<xsl:template match="linebreak">
- <xsl:text>&#10;</xsl:text>
+ <literallayout>
+ </literallayout>
+ </xsl:template>
+
+ <xsl:template match="verbatim">
+ <programlisting>
+ <xsl:apply-templates/>
+ </programlisting>
+ </xsl:template>
+
+ <xsl:template match="sectiondef">
+ <para>
+ <xsl:value-of select="description"/>
+ </para>
+
+ <xsl:apply-templates select="memberdef"/>
+ </xsl:template>
+
+ <xsl:template match="simplesect" mode="struct">
+ <footnote>
+ <xsl:apply-templates/>
+ </footnote>
+ </xsl:template>
+
+ <xsl:template match="simplesect">
+ <xsl:choose>
+ <xsl:when test="@kind = 'warning'">
+ <warning>
+ <title>Warning</title>
+ <xsl:apply-templates select="para"/>
+ </warning>
+ </xsl:when>
+
+ <xsl:when test="@kind = 'return'">
+ <note>
+ <title>Returns</title>
+ <xsl:apply-templates select="para"/>
+ </note>
+ </xsl:when>
+
+ <xsl:when test="@kind = 'pre'">
+ <note>
+ <title>Precondition</title>
+ <xsl:apply-templates select="para"/>
+ </note>
+ </xsl:when>
+
+ <xsl:when test="@kind = 'par'">
+ <note>
+ <title>
+ <xsl:value-of select="title"/>
+ </title>
+ <xsl:apply-templates select="para"/>
+ </note>
+ </xsl:when>
+
+ <xsl:when test="@kind = 'see'">
+ <note>
+ <title>See also</title>
+ <xsl:apply-templates select="para"/>
+ </note>
+ </xsl:when>
+
+ <xsl:when test="@kind = 'note'">
+ <note>
+ <title>Note</title>
+ <xsl:apply-templates select="para"/>
+ </note>
+ </xsl:when>
+
+ </xsl:choose>
+ </xsl:template>
+
+ <xsl:template match="parameterlist[@kind = 'param']">
+ <table tabstyle="striped">
+ <title>Parameters</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Data Direction</entry>
+ <entry>Parameter Name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <xsl:for-each select="parameteritem">
+ <row>
+ <xsl:apply-templates select="."/>
+ </row>
+ </xsl:for-each>
+ </tbody>
+ </tgroup>
+ </table>
+ </xsl:template>
+
+ <xsl:template match="parameterlist[@kind = 'retval']">
+ <table tabstyle="striped">
+ <title>Return Values</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Return Value</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <xsl:for-each select="parameteritem">
+ <row>
+ <xsl:apply-templates select="."/>
+ </row>
+ </xsl:for-each>
+ </tbody>
+ </tgroup>
+ </table>
+ </xsl:template>
+
+ <xsl:template match="parameteritem">
+ <xsl:if test="parent::parameterlist/@kind = 'param'">
+ <entry>
+ <para>
+ <xsl:choose>
+ <xsl:when test="not(descendant::parametername/@direction)">
+ <emphasis role="italic">?</emphasis>
+ </xsl:when>
+ <xsl:otherwise>
+ <emphasis role="bold">
+ [<xsl:value-of select="descendant::parametername/@direction"/>]
+ </emphasis>
+ </xsl:otherwise>
+ </xsl:choose>
+ </para>
+ </entry>
+ </xsl:if>
+
+ <entry>
+ <para>
+ <xsl:value-of select="parameternamelist/parametername"/>
+ </para>
+ </entry>
+
+ <entry>
+ <xsl:apply-templates select="parameterdescription"/>
+ </entry>
+ </xsl:template>
+
+ <xsl:template match="type">
+ <xsl:apply-templates/>
+ </xsl:template>
+
+ <xsl:template match="para">
+ <para>
+ <xsl:apply-templates/>
+ </para>
+ </xsl:template>
+
+ <xsl:template match="bold">
+ <emphasis role="bold">
+ <xsl:value-of select="."/>
+ </emphasis>
+ </xsl:template>
+
+ <xsl:template match="emphasis">
+ <emphasis role="italic">
+ <xsl:value-of select="."/>
+ </emphasis>
+ </xsl:template>
+
+ <xsl:template match="computeroutput">
+ <computeroutput>
+ <xsl:value-of select="."/>
+ </computeroutput>
+ </xsl:template>
+
+ <xsl:template match="ulink">
+ <ulink url="{@url}">
+ <xsl:value-of select="."/>
+ </ulink>
+ </xsl:template>
+
+ <xsl:template match="registered">
+ <xsl:text>&#174;</xsl:text>
+ </xsl:template>
+
+ <xsl:template match="copy">
+ <xsl:text>&#169;</xsl:text>
+ </xsl:template>
+
+ <xsl:template match="trademark">
+ <xsl:text>&#8482;</xsl:text>
+ </xsl:template>
+
+ <xsl:template match="superscript">
+ <superscript>
+ <xsl:value-of select="."/>
+ </superscript>
+ </xsl:template>
+
+ <xsl:template match="subscript">
+ <subscript>
+ <xsl:value-of select="."/>
+ </subscript>
+ </xsl:template>
+
+ <xsl:template match="ref">
+ <xsl:choose>
+ <!-- Don't show links inside program listings -->
+ <xsl:when test="ancestor::programlisting">
+ <xsl:value-of select="."/>
+ </xsl:when>
+
+ <!-- Show links outside program listings -->
+ <xsl:otherwise>
+ <link linkend="{@refid}">
+ <xsl:value-of select="text()"/>
+ </link>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:template>
+
+ <xsl:template match="table">
+ <xsl:choose>
+ <xsl:when test="caption">
+ <table tabstyle="striped">
+ <title>
+ <xsl:value-of select="caption"/>
+ </title>
+ <xsl:call-template name="write.table.content"/>
+ </table>
+ </xsl:when>
+ <xsl:otherwise>
+ <informaltable tabstyle="striped">
+ <xsl:call-template name="write.table.content"/>
+ </informaltable>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:template>
+
+ <xsl:template name="write.table.content">
+ <tgroup cols="{@cols}">
+ <thead>
+ <xsl:for-each select="row[1]">
+ <row>
+ <xsl:for-each select="entry">
+ <entry>
+ <xsl:apply-templates select="."/>
+ </entry>
+ </xsl:for-each>
+ </row>
+ </xsl:for-each>
+ </thead>
+ <tbody>
+ <xsl:for-each select="row[position() != 1]">
+ <row>
+ <xsl:for-each select="entry">
+ <entry>
+ <xsl:apply-templates select="."/>
+ </entry>
+ </xsl:for-each>
+ </row>
+ </xsl:for-each>
+ </tbody>
+ </tgroup>
+ </xsl:template>
+
+ <xsl:template match="itemizedlist">
+ <itemizedlist>
+ <xsl:apply-templates select="listitem"/>
+ </itemizedlist>
+ </xsl:template>
+
+ <xsl:template match="orderedlist">
+ <orderedlist>
+ <xsl:apply-templates select="listitem"/>
+ </orderedlist>
+ </xsl:template>
+
+ <xsl:template match="listitem">
+ <listitem>
+ <xsl:apply-templates/>
+ </listitem>
+ </xsl:template>
+
+ <xsl:template match="programlisting">
+ <programlisting language="c">
+ <xsl:for-each select="codeline[position() > 1 or highlight]">
+ <xsl:apply-templates select="."/>
+ <xsl:text>&#10;</xsl:text>
+ </xsl:for-each>
+ </programlisting>
+ </xsl:template>
+
+ <xsl:template match="highlight">
+ <emphasis role="{@class}">
+ <xsl:apply-templates/>
+ </emphasis>
+ </xsl:template>
+
+ <xsl:template match="sp[ancestor::codeline]">
+ <xsl:text> </xsl:text>
</xsl:template>
<xsl:template match="image">
@@ -448,7 +755,10 @@
<mediaobject>
<imageobject>
<imagedata>
- <xsl:attribute name="fileref">images/<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:attribute name="fileref">
+ <xsl:text>images/</xsl:text>
+ <xsl:value-of select="@name"/>
+ </xsl:attribute>
</imagedata>
</imageobject>
</mediaobject>
@@ -483,67 +793,4 @@
<xsl:template match="title"/>
- <xsl:template match="indexentry">
- <xsl:variable name="prim">
- <xsl:choose>
- <xsl:when test="contains(primaryie, ',')">
- <xsl:value-of select="normalize-space(substring-before(primaryie, ','))"/>
- </xsl:when>
- <xsl:otherwise>
- <xsl:value-of select="primaryie"/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:variable>
-
- <xsl:variable name="sec">
- <xsl:choose>
- <xsl:when test="contains(primaryie, ',')">
- <xsl:value-of select="normalize-space(substring-after(primaryie, ','))"/>
- </xsl:when>
- <xsl:when test="seondariye">
- <xsl:value-of select="secondaryie"/>
- </xsl:when>
- <xsl:otherwise/>
- </xsl:choose>
- </xsl:variable>
-
- <xsl:variable name="tert">
- <xsl:choose>
- <xsl:when test="contains(primaryie, ',')">
- <xsl:choose>
- <xsl:when test="secondaryie">
- <xsl:value-of select="secondaryie"/>
- </xsl:when>
- </xsl:choose>
- </xsl:when>
- <xsl:when test="tertiaryie">
- <xsl:value-of select="tertiaryie"/>
- </xsl:when>
- <xsl:otherwise/>
- </xsl:choose>
- </xsl:variable>
-
- <indexterm>
- <xsl:if test="@id">
- <xsl:attribute name="id">
- <xsl:value-of select="@id"/>
- </xsl:attribute>
- </xsl:if>
- <xsl:if test="$prim">
- <primary>
- <xsl:value-of select="$prim"/>
- </primary>
- </xsl:if>
- <xsl:if test="$sec">
- <secondary>
- <xsl:value-of select="$sec"/>
- </secondary>
- </xsl:if>
- <xsl:if test="$tert">
- <tertiary>
- <xsl:value-of select="$tert"/>
- </tertiary>
- </xsl:if>
- </indexterm>
- </xsl:template>
</xsl:stylesheet>
diff --git a/LUFA/StudioIntegration/HV1/transform_base.xsl b/LUFA/StudioIntegration/HV1/transform_base.xsl
deleted file mode 100644
index 8ff34285f..000000000
--- a/LUFA/StudioIntegration/HV1/transform_base.xsl
+++ /dev/null
@@ -1,823 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- xmlns:exsl="http://exslt.org/common"
- extension-element-prefixes="exsl"
- exclude-result-prefixes="exsl"
- version="1.0">
-
- <xsl:output
- method="xml" indent="no"
- doctype-public="-//OASIS//DTD DocBook XML V4.5//EN"
- doctype-system="http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"/>
-
- <xsl:template name="write.api.overview.contents">
-
- <xsl:if test="count(ancestor::*/sectiondef[memberdef/@kind = 'variable' or memberdef/@kind = 'typedef']) > 0">
- <section>
- <title>Variable and Type Definitions</title>
-
- <xsl:for-each select="ancestor::*/sectiondef[memberdef/@kind = 'variable' or memberdef/@kind = 'typedef']">
- <section>
- <title>
- <xsl:value-of select="header"/>
- </title>
-
- <xsl:apply-templates select="description"/>
- <xsl:apply-templates select="memberdef[@kind = 'variable' or @kind = 'typedef']"/>
- </section>
- </xsl:for-each>
- </section>
- </xsl:if>
-
- <xsl:if test="count(ancestor::*/innerclass) > 0">
- <section>
- <title>Structure Definitions</title>
-
- <xsl:for-each select="ancestor::*/innerclass">
- <xsl:apply-templates select="ancestor::*/compounddef[@id = current()/@refid]"/>
- </xsl:for-each>
- </section>
- </xsl:if>
-
- <xsl:if test="count(ancestor::*/sectiondef[memberdef/@kind = 'define']) > 0">
- <section>
- <title>Macro Definitions</title>
-
- <xsl:for-each select="ancestor::*/sectiondef[memberdef/@kind = 'define']">
- <section>
- <title>
- <xsl:value-of select="header"/>
- </title>
-
- <xsl:apply-templates select="description"/>
- <xsl:apply-templates select="memberdef[@kind = 'define']"/>
- </section>
- </xsl:for-each>
- </section>
- </xsl:if>
-
- <xsl:if test="count(ancestor::*/sectiondef[memberdef/@kind = 'function']) > 0">
- <section>
- <title>Function Definitions</title>
-
- <xsl:for-each select="ancestor::*/sectiondef[memberdef/@kind = 'function']">
- <section>
- <title>
- <xsl:value-of select="header"/>
- </title>
-
- <xsl:apply-templates select="description"/>
- <xsl:apply-templates select="memberdef[@kind = 'function']"/>
- </section>
- </xsl:for-each>
- </section>
- </xsl:if>
-
- <xsl:if test="count(ancestor::*/sectiondef[@kind = 'enum']) > 0">
- <section>
- <title>Enumeration Definitions</title>
-
- <xsl:apply-templates select="ancestor::*/sectiondef[@kind = 'enum']"/>
- </section>
- </xsl:if>
-
- </xsl:template>
-
- <xsl:template match="compounddef">
- <!-- Discard compounddef elements unless a later template matches -->
- </xsl:template>
-
- <xsl:template match="compounddef[@kind = 'struct' or @kind = 'union']">
- <section id="{@id}" xreflabel="{compoundname}">
- <title>
- <xsl:choose>
- <xsl:when test="@kind = 'struct'">
- <xsl:text>Struct </xsl:text>
- </xsl:when>
- <xsl:when test="@kind = 'union'">
- <xsl:text>Union </xsl:text>
- </xsl:when>
- </xsl:choose>
-
- <xsl:value-of select="compoundname"/>
- </title>
-
- <xsl:apply-templates select="detaileddescription"/>
-
- <xsl:for-each select="sectiondef[@kind = 'public-attrib']">
- <table tabstyle="striped">
- <title>Members</title>
-
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Type</entry>
- <entry>Name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <xsl:for-each select="memberdef">
- <row id="{@id}" xreflabel="{name}">
- <entry>
- <xsl:apply-templates select="type"/>
- </entry>
- <entry>
- <xsl:value-of select="name"/>
- <xsl:if test="starts-with(argsstring, '[')">
- <xsl:text>[]</xsl:text>
- </xsl:if>
- </entry>
- <entry>
- <xsl:apply-templates select="detaileddescription" mode="struct"/>
- </entry>
- </row>
- </xsl:for-each>
- </tbody>
- </tgroup>
- </table>
- <para>&#xa0;</para>
- </xsl:for-each>
- </section>
- </xsl:template>
-
- <xsl:template match="memberdef[@kind = 'function']">
- <section id="{@id}" xreflabel="{name}">
- <title> Function <xsl:value-of select="name"/>() </title>
-
- <para>
- <emphasis role="italic">
- <xsl:value-of select="briefdescription"/>
- </emphasis>
- </para>
-
- <programlisting language="c">
- <emphasis role="keyword">
- <xsl:value-of select="type"/>
- </emphasis>
- <xsl:text> </xsl:text>
- <xsl:value-of select="name"/>
- <xsl:text>(</xsl:text>
-
- <xsl:choose>
- <xsl:when test="argsstring = '(void)'">
- <emphasis role="keyword">void</emphasis>
- </xsl:when>
-
- <xsl:otherwise>
- <xsl:for-each select="param">
- <xsl:if test="position() > 1">
- <xsl:text>,</xsl:text>
- </xsl:if>
- <xsl:text>&#10;&#9;&#9;</xsl:text>
- <emphasis role="keyword">
- <xsl:value-of select="type"/>
- </emphasis>
- <xsl:text> </xsl:text>
- <xsl:value-of select="declname"/>
- </xsl:for-each>
- </xsl:otherwise>
- </xsl:choose>
-
- <xsl:text>)</xsl:text>
- </programlisting>
-
- <xsl:apply-templates select="detaileddescription"/>
-
- <para>&#xa0;</para>
- </section>
- </xsl:template>
-
- <xsl:template match="memberdef[@kind = 'enum']">
- <section id="{@id}" xreflabel="{name}">
- <title> Enum <xsl:value-of select="name"/> </title>
-
- <xsl:apply-templates select="detaileddescription"/>
-
- <table tabstyle="striped">
- <title>Members</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Enum value</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <xsl:for-each select="enumvalue">
- <row>
- <entry>
- <para id="{@id}" xreflabel="{name}">
- <xsl:value-of select="name"/>
- </para>
- </entry>
- <entry>
- <xsl:apply-templates select="detaileddescription"/>
- </entry>
- </row>
- </xsl:for-each>
- </tbody>
- </tgroup>
- </table>
-
- <para>&#xa0;</para>
- </section>
- </xsl:template>
-
- <xsl:template match="memberdef[@kind = 'define']">
- <section id="{@id}" xreflabel="{name}">
- <title> Macro <xsl:value-of select="name"/> </title>
-
- <programlisting language="c">
- <emphasis role="preprocessor">
- <xsl:text>#define </xsl:text>
- <xsl:value-of select="name"/>
- <xsl:if test="count(param) > 0">
- <xsl:text>(</xsl:text>
- <xsl:for-each select="param/defname">
- <xsl:if test="position() > 1">
- <xsl:text>, </xsl:text>
- </xsl:if>
- <xsl:value-of select="."/>
- </xsl:for-each>
- <xsl:text>)</xsl:text>
- </xsl:if>
- <xsl:text> </xsl:text>
-
- <!-- Split long macro definitions across multiple lines -->
- <xsl:if test="(string-length(initializer) > 50) or (count(param) > 0)">
- <xsl:text>\&#10;&#09;&#9;</xsl:text>
- </xsl:if>
-
- <xsl:value-of select="initializer"/>
- </emphasis>
- <xsl:text> </xsl:text>
- </programlisting>
-
- <xsl:apply-templates select="detaileddescription"/>
-
- <para>&#xa0;</para>
- </section>
- </xsl:template>
-
- <xsl:template match="memberdef[@kind = 'variable' or @kind = 'typedef']">
- <section id="{@id}" xreflabel="{name}">
- <!-- Doxygen gets confused and thinks function pointer type definitions
- are variables, so we need to map them to this common section and
- check the definition to see which of the two it is. -->
- <xsl:choose>
- <xsl:when test="contains(definition,'typedef')">
- <title> Type <xsl:value-of select="name"/></title>
-
- <programlisting language="c">
- <emphasis role="keyword">
- <xsl:text>typedef </xsl:text>
- <xsl:value-of select="type"/>
- </emphasis>
- <xsl:text> </xsl:text>
- <xsl:value-of select="name"/>
- <xsl:text> </xsl:text>
- <xsl:value-of select="argsstring"/>
- </programlisting>
- </xsl:when>
-
- <xsl:otherwise>
- <title> Variable <xsl:value-of select="name"/></title>
-
- <programlisting language="c">
- <emphasis role="keyword">
- <xsl:value-of select="type"/>
- </emphasis>
- <xsl:text> </xsl:text>
- <xsl:value-of select="name"/>
- </programlisting>
- </xsl:otherwise>
- </xsl:choose>
-
- <xsl:apply-templates select="detaileddescription"/>
-
- <para>&#xa0;</para>
- </section>
- </xsl:template>
-
- <xsl:template match="sectiondef">
- <para>
- <xsl:value-of select="description"/>
- </para>
-
- <xsl:apply-templates select="memberdef"/>
- </xsl:template>
-
- <xsl:template match="simplesect" mode="struct">
- <footnote>
- <xsl:apply-templates/>
- </footnote>
- </xsl:template>
-
- <xsl:template match="simplesect">
- <xsl:choose>
- <xsl:when test="@kind = 'warning'">
- <warning>
- <title>Warning</title>
- <xsl:apply-templates select="para"/>
- </warning>
- </xsl:when>
-
- <xsl:when test="@kind = 'return'">
- <note>
- <title>Returns</title>
- <xsl:apply-templates select="para"/>
- </note>
- </xsl:when>
-
- <xsl:when test="@kind = 'pre'">
- <note>
- <title>Precondition</title>
- <xsl:apply-templates select="para"/>
- </note>
- </xsl:when>
-
- <xsl:when test="@kind = 'par'">
- <note>
- <title>
- <xsl:value-of select="title"/>
- </title>
- <xsl:apply-templates select="para"/>
- </note>
- </xsl:when>
-
- <xsl:when test="@kind = 'see'">
- <note>
- <title>See also</title>
- <xsl:apply-templates select="para"/>
- </note>
- </xsl:when>
-
- <xsl:when test="@kind = 'note'">
- <!-- Notes can have special prefix keywords to transform them into
- special styles for training documents ("AlfonsoNotes(TM)") -->
- <xsl:variable name="note.prefix" select="substring-before(para[1]/text(), ' ')"/>
-
- <note>
- <xsl:choose>
- <xsl:when test="$note.prefix = 'TODO:'">
- <xsl:attribute name="role">todo</xsl:attribute>
- <title>To Do</title>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'TIPS:'">
- <xsl:attribute name="role">tips</xsl:attribute>
- <title>Tip</title>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'INFO:'">
- <xsl:attribute name="role">info</xsl:attribute>
- <title>Info</title>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'RESULT:'">
- <xsl:attribute name="role">result</xsl:attribute>
- <title>Result</title>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'EXECUTE:'">
- <xsl:attribute name="role">execute</xsl:attribute>
- <title>Execute</title>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'WARNING:'">
- <xsl:attribute name="role">warning</xsl:attribute>
- <title>Warning</title>
- </xsl:when>
-
- <xsl:otherwise/>
- </xsl:choose>
-
- <xsl:apply-templates select="para"/>
- </note>
- </xsl:when>
-
- </xsl:choose>
- </xsl:template>
-
- <!-- Strip off the special note type prefix from the special training document
- style notes ("AlfonsoNotes(TM)") if one is present. -->
- <xsl:template match="para[parent::simplesect/@kind='note']/text()">
- <xsl:variable name="note.prefix" select="substring-before(., ' ')"/>
- <xsl:variable name="note.content" select="substring-after(., ' ')"/>
-
- <xsl:choose>
- <xsl:when test="$note.prefix = 'TODO:'">
- <xsl:value-of select="$note.content"/>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'TIPS:'">
- <xsl:value-of select="$note.content"/>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'INFO:'">
- <xsl:value-of select="$note.content"/>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'RESULT:'">
- <xsl:value-of select="$note.content"/>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'EXECUTE:'">
- <xsl:value-of select="$note.content"/>
- </xsl:when>
-
- <xsl:when test="$note.prefix = 'WARNING:'">
- <xsl:value-of select="$note.content"/>
- </xsl:when>
-
- <xsl:otherwise>
- <xsl:value-of select="."/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
-
- <xsl:template match="parameterlist[@kind = 'param']">
- <table tabstyle="striped">
- <title>Parameters</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Data direction</entry>
- <entry>Parameter name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <xsl:for-each select="parameteritem">
- <row>
- <xsl:apply-templates select="."/>
- </row>
- </xsl:for-each>
- </tbody>
- </tgroup>
- </table>
- </xsl:template>
-
- <xsl:template match="parameterlist[@kind = 'retval']">
- <table tabstyle="striped">
- <title>Return Values</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Return value</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <xsl:for-each select="parameteritem">
- <row>
- <xsl:apply-templates select="."/>
- </row>
- </xsl:for-each>
- </tbody>
- </tgroup>
- </table>
- </xsl:template>
-
- <xsl:template match="parameteritem">
- <xsl:if test="parent::parameterlist/@kind = 'param'">
- <entry>
- <para>
- <xsl:choose>
- <xsl:when test="not(descendant::parametername/@direction)">
- <emphasis role="italic">?</emphasis>
- </xsl:when>
- <xsl:otherwise>
- <emphasis role="bold">[<xsl:value-of select="descendant::parametername/@direction"/>]</emphasis>
- </xsl:otherwise>
- </xsl:choose>
- </para>
- </entry>
- </xsl:if>
-
- <entry>
- <para>
- <xsl:value-of select="parameternamelist/parametername"/>
- </para>
- </entry>
-
- <entry>
- <xsl:apply-templates select="parameterdescription"/>
- </entry>
- </xsl:template>
-
- <xsl:template match="type">
- <xsl:apply-templates/>
- </xsl:template>
-
- <xsl:template match="sect1">
- <section id="{@id}" xreflabel="{title}">
- <title>
- <xsl:value-of select="title"/>
- </title>
-
- <xsl:apply-templates select="para"/>
- <xsl:apply-templates select="sect2"/>
- </section>
- </xsl:template>
-
- <xsl:template match="sect2">
- <section id="{@id}" xreflabel="{title}">
- <title>
- <xsl:value-of select="title"/>
- </title>
-
- <xsl:apply-templates select="para"/>
- <xsl:apply-templates select="sect3"/>
- </section>
- </xsl:template>
-
- <xsl:template match="sect3">
- <section id="{@id}" xreflabel="{title}">
- <title>
- <xsl:value-of select="title"/>
- </title>
-
- <xsl:apply-templates select="para"/>
- </section>
- </xsl:template>
-
- <xsl:template match="detaileddescription">
- <xsl:apply-templates select="para"/>
- <xsl:apply-templates select="sect1"/>
- </xsl:template>
-
- <xsl:template match="para">
- <para>
- <xsl:apply-templates/>
- </para>
- </xsl:template>
-
- <xsl:template match="bold">
- <emphasis role="bold">
- <xsl:value-of select="."/>
- </emphasis>
- </xsl:template>
-
- <xsl:template match="emphasis">
- <emphasis role="italic">
- <xsl:value-of select="."/>
- </emphasis>
- </xsl:template>
-
- <xsl:template match="computeroutput">
- <computeroutput>
- <xsl:value-of select="."/>
- </computeroutput>
- </xsl:template>
-
- <xsl:template match="ulink">
- <ulink url="{@url}">
- <xsl:value-of select="."/>
- </ulink>
- </xsl:template>
-
- <xsl:template match="registered">
- <xsl:text>&#174;</xsl:text>
- </xsl:template>
-
- <xsl:template match="copy">
- <xsl:text>&#169;</xsl:text>
- </xsl:template>
-
- <xsl:template match="trademark">
- <xsl:text>&#8482;</xsl:text>
- </xsl:template>
-
- <xsl:template match="superscript">
- <superscript>
- <xsl:value-of select="."/>
- </superscript>
- </xsl:template>
-
- <xsl:template match="subscript">
- <subscript>
- <xsl:value-of select="."/>
- </subscript>
- </xsl:template>
-
- <xsl:template match="ref">
- <xsl:choose>
- <!-- Don't show links inside program listings -->
- <xsl:when test="ancestor::programlisting">
- <xsl:value-of select="."/>
- </xsl:when>
-
- <!-- Show links outside program listings -->
- <xsl:otherwise>
- <xsl:choose>
- <!-- Use hard links for anchors to make the reference
- look correct for figure and table references -->
- <xsl:when test="//anchor[@id = current()/@refid]">
- <xref linkend="{@refid}" xrefstyle="select: label title"/>
- </xsl:when>
- <xsl:otherwise>
- <link linkend="{@refid}">
- <xsl:value-of select="text()"/>
- </link>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
-
- <xsl:template match="formula">
- <equation>
- <!-- LaTeX equation generation requires JLatexMath and its associated
- FOP plugin, or you will get missing equations in the output -->
- <latex align="center" xmlns="http://forge.scilab.org/p/jlatexmath">
- <xsl:value-of select="."/>
- </latex>
- </equation>
- </xsl:template>
-
- <xsl:template match="table">
- <xsl:choose>
- <xsl:when test="caption">
- <!-- Fetch the ID using a preceding doxygen \anchor to be
- able to reference tables -->
- <table tabstyle="striped" id="{preceding-sibling::anchor[last()]/@id}">
- <title>
- <xsl:value-of select="caption"/>
- </title>
- <xsl:call-template name="write.table.content"/>
- </table>
- </xsl:when>
- <xsl:otherwise>
- <informaltable tabstyle="striped">
- <xsl:call-template name="write.table.content"/>
- </informaltable>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
-
- <xsl:template name="write.table.content">
- <tgroup cols="{@cols}">
- <thead>
- <xsl:for-each select="row[1]">
- <row>
- <xsl:for-each select="entry">
- <entry>
- <xsl:apply-templates select="."/>
- </entry>
- </xsl:for-each>
- </row>
- </xsl:for-each>
- </thead>
- <tbody>
- <xsl:for-each select="row[position() != 1]">
- <row>
- <xsl:for-each select="entry">
- <entry>
- <xsl:apply-templates select="."/>
- </entry>
- </xsl:for-each>
- </row>
- </xsl:for-each>
- </tbody>
- </tgroup>
- </xsl:template>
-
- <xsl:template match="itemizedlist">
- <itemizedlist>
- <xsl:apply-templates select="listitem"/>
- </itemizedlist>
- </xsl:template>
-
- <xsl:template match="orderedlist">
- <orderedlist>
- <xsl:apply-templates select="listitem"/>
- </orderedlist>
- </xsl:template>
-
- <xsl:template match="listitem">
- <listitem>
- <xsl:apply-templates/>
- </listitem>
- </xsl:template>
-
- <xsl:template match="programlisting">
- <programlisting language="c">
- <!-- Only allow really long code segments to split across pages -->
- <xsl:if test="count(codeline) > 30">
- <xsl:processing-instruction name="dbfo">keep-together="auto"</xsl:processing-instruction>
- </xsl:if>
-
- <xsl:for-each select="codeline[position() > 1 or highlight]">
- <xsl:apply-templates select="."/>
- <xsl:text>&#10;</xsl:text>
- </xsl:for-each>
- </programlisting>
- </xsl:template>
-
- <xsl:template match="highlight">
- <emphasis role="{@class}">
- <xsl:apply-templates/>
- </emphasis>
- </xsl:template>
-
- <xsl:template match="sp[ancestor::codeline]">
- <xsl:choose>
- <!-- Need to check if this is the first part of the line - if so we may
- need to strip off any leading <sp/> element indentation -->
- <xsl:when test="count(../preceding-sibling::highlight) = 0">
- <!-- Doxygen retains a level of indentation in some code fragments - obtain
- the base indentation level by counting the leading <sp/> elements of the
- first code line, and use that to remove the indentation on the rest -->
- <xsl:variable name="leading.spaces" select="count(ancestor::programlisting/codeline[highlight][1]/highlight[1]/sp[not(preceding-sibling::text())])"/>
-
- <xsl:if test="position() > $leading.spaces">
- <xsl:text> </xsl:text>
- </xsl:if>
- </xsl:when>
-
- <xsl:otherwise>
- <xsl:text> </xsl:text>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
-
- <xsl:template match="image">
- <!-- Fetch the ID using a preceding doxygen \anchor to be
- able to reference figures -->
- <figure id="{preceding-sibling::anchor[last()]/@id}">
- <title>
- <xsl:value-of select="."/>
- </title>
-
- <mediaobject>
- <imageobject>
- <imagedata scalefit="1" width="{@width}">
- <xsl:attribute name="fileref">
- <xsl:text>html/</xsl:text>
- <xsl:value-of select="@name"/>
- </xsl:attribute>
- </imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </xsl:template>
-
- <xsl:template match="anchor">
- <!-- Remove anchors from the PDF output, as these are used for referencing
- images and tables. -->
- </xsl:template>
-
- <xsl:template match="dot">
- <!-- Fetch the ID using a preceding doxygen \anchor to be able to reference
- figures -->
- <xsl:variable name="dot.id" select="preceding-sibling::anchor[last()]/@id" />
-
- <xsl:choose>
- <!-- If the DOT graph has an ID, use that for the filename -->
- <xsl:when test="$dot.id">
- <xsl:call-template name="write.dot.content">
- <xsl:with-param name="dot.filename" select="$dot.id"/>
- <xsl:with-param name="dot.id" select="$dot.id"/>
- </xsl:call-template>
- </xsl:when>
-
- <!-- Otherwise use the auto-generated ID for it in the document -->
- <xsl:otherwise>
- <xsl:call-template name="write.dot.content"/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:template>
-
- <xsl:template name="write.dot.content">
- <xsl:param name="dot.filename" select="generate-id(.)"/>
- <xsl:param name="dot.id" select="''"/>
-
- <!-- We get raw DOT syntax rather than a rendered image: write the DOT code
- to a external file, and make a image reference to a SVG version of that
- file. The build system should then call dot to render all generated
- DOT files into their SVG equivalents before rendering the PDF. -->
- <exsl:document href="{$dot.filename}.dot" method="text">
- <xsl:value-of select="." />
- </exsl:document>
-
- <figure id="{$dot.id}">
- <title>
- <xsl:value-of select="ancestor::*/title"/>
- </title>
- <mediaobject>
- <imageobject>
- <imagedata format="SVG">
- <xsl:attribute name="fileref">
- <xsl:value-of select="$dot.filename" />
- <xsl:text>.svg</xsl:text>
- </xsl:attribute>
- </imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </xsl:template>
-
-</xsl:stylesheet>