eqmk
/
qmk_firmware
forked from mfulz_github/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add check to the Doxygen->Docbook transform to warning on untemplated items. Add additional templates to ensure the output documentation does not have unescaped or unformatted entries.

This commit is contained in:
Dean Camera 2013-05-04 14:38:11 +00:00
parent db929fd4c8
commit fd5e98d380
1 changed files with 35 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt
View File

@ -103,10 +103,6 @@
</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>
@ -305,16 +301,14 @@
</xsl:template>
<xsl:template match="memberdef[@kind = 'enum']">
<xsl:variable name="name" select="name"/>
<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">
<xsl:with-param name="name" select="$name"/>
<xsl:with-param name="name" select="name"/>
</xsl:call-template>
<xsl:apply-templates select="detaileddescription"/>
@ -334,7 +328,7 @@
<entry>
<para id="{@id}" xreflabel="{name}">
<xsl:value-of select="name"/>
<indexterm id="{$keyword.namespace}.{$name}.{name}"/>
<indexterm id="{$keyword.namespace}.{name}"/>
</para>
</entry>
<entry>
@ -588,16 +582,16 @@
</entry>
</xsl:template>
<xsl:template match="type">
<xsl:apply-templates/>
</xsl:template>
<xsl:template match="para">
<xsl:template match="parameterdescription">
<para>
<xsl:apply-templates/>
</para>
</xsl:template>
<xsl:template match="type">
<xsl:apply-templates/>
</xsl:template>
<xsl:template match="bold">
<emphasis role="bold">
<xsl:apply-templates/>
@ -614,12 +608,20 @@
<xsl:apply-templates/>
</xsl:template>
<xsl:template match="computeroutput">
<xsl:template match="mdash | ndash">
<xsl:text>--</xsl:text>
</xsl:template>
<xsl:template match="computeroutput | preformatted">
<computeroutput>
<xsl:apply-templates/>
</computeroutput>
</xsl:template>
<xsl:template match="codeline">
<xsl:apply-templates/>
</xsl:template>
<xsl:template match="ulink">
<ulink url="{@url}">
<xsl:value-of select="."/>
@ -638,6 +640,12 @@
</subscript>
</xsl:template>
<xsl:template match="para">
<para>
<xsl:apply-templates/>
</para>
</xsl:template>
<xsl:template match="ref">
<xsl:choose>
<!-- Don't show links inside program listings -->
@ -659,6 +667,12 @@
</xsl:choose>
</xsl:template>
<xsl:template match="entry">
<entry>
<xsl:apply-templates/>
</entry>
</xsl:template>
<xsl:template match="table">
<xsl:choose>
<xsl:when test="caption">
@ -683,22 +697,14 @@
<thead>
<xsl:for-each select="row[1]">
<row>
<xsl:for-each select="entry">
<entry>
<xsl:apply-templates select="."/>
</entry>
</xsl:for-each>
<xsl:apply-templates select="entry"/>
</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>
<xsl:apply-templates select="entry"/>
</row>
</xsl:for-each>
</tbody>
@ -783,4 +789,8 @@
<xsl:template match="title"/>
<xsl:template match="*">
<xsl:message>NO XSL TEMPLATE MATCH: <xsl:value-of select="name()"/></xsl:message>
</xsl:template>
</xsl:stylesheet>