ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update AS integration scripts and transforms - extract out the module description from the Doxygen XML output for the GUI.

Browse source
This commit is contained in:
Dean Camera 2013-04-08 18:59:25 +00:00
parent c2f9eba33f
commit ebd059d0eb
4 changed files with 23 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

23
LUFA/StudioIntegration/XSLT/lufa_module_transform.xslt
View file

@ -17,6 +17,9 @@
<!-- Store the LUFA Doxygen tag filename mentioned in the root node for later use -->
<xsl:param name="lufa-doxygen-tagfile" select="lufa-manifest/@tagfile"/>
<!-- Store the LUFA Doxygen documentation filename mentioned in the root node for later use -->
<xsl:param name="lufa-doxygen-docfile" select="lufa-manifest/@docfile"/>
<!-- Read manifest list, add a comment to indicate the source filename
and then copy/process all ASF nodes in the referenced document -->
<xsl:template match="lufa-manifest">
@ -38,22 +41,20 @@
</xsl:template>
<!-- For Doxygen entry point nodes we need to convert them into help link
nodes instead, so that they show up as links in Studio correctly -->
nodes instead and add descriptions, so that they show up as links in
Studio correctly -->
<xsl:template match="build[@type='doxygen-entry-point']">
<xsl:call-template name="add_help_nodes">
<xsl:with-param name="filename" select="document($lufa-doxygen-tagfile)//compound[name=current()/@value]/filename"/>
</xsl:call-template>
</xsl:template>
<!-- Generate additional help nodes from the given help filename -->
<xsl:template name="add_help_nodes">
<xsl:param name="filename"/>
<build type="online-help" subtype="module-help-page-append">
<xsl:attribute name="value">
<xsl:value-of select="$filename"/>
<!-- Extract filename of the HTML file that contains the documentation for this module from the Doxgen tag file -->
<xsl:value-of select="document($lufa-doxygen-tagfile)/tagfile/compound[name=current()/@value]/filename"/>
</xsl:attribute>
</build>
<info type="description" value="summary">
<!-- Extract brief description of the module from the Doxygen combined XML documentation file -->
<xsl:value-of select="document($lufa-doxygen-docfile)/doxygen/compounddef[compoundname=current()/@value]/briefdescription/para"/>
</info>
</xsl:template>
</xsl:stylesheet>