aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-01-03 16:08:44 +0000
committerDean Camera <dean@fourwalledcubicle.com>2013-01-03 16:08:44 +0000
commit5386a5a7ffd4a2b739ce6f41d918378a6f70da15 (patch)
treecf17a47a11667259994ed2b038fa4a4adfe93709
parent340b2dc0bcd039f07f8d66e19384b3f9168333d7 (diff)
downloadlufa-5386a5a7ffd4a2b739ce6f41d918378a6f70da15.tar.gz
lufa-5386a5a7ffd4a2b739ce6f41d918378a6f70da15.tar.bz2
lufa-5386a5a7ffd4a2b739ce6f41d918378a6f70da15.zip
Update Studio Integration XML transform files to add top-level descriptions for each transform. Update module transform to remove spacing between modules in the generated document and to remove the unused doxygen-entry-point nodes once they have been converted into online and offline documentation nodes.
-rw-r--r--LUFA/StudioIntegration/lufa_extension_transform.xslt3
-rw-r--r--LUFA/StudioIntegration/lufa_filelist_transform.xslt2
-rw-r--r--LUFA/StudioIntegration/lufa_indent_transform.xslt1
-rw-r--r--LUFA/StudioIntegration/lufa_module_transform.xslt18
4 files changed, 11 insertions, 13 deletions
diff --git a/LUFA/StudioIntegration/lufa_extension_transform.xslt b/LUFA/StudioIntegration/lufa_extension_transform.xslt
index 7796b2d69..a40176a8a 100644
--- a/LUFA/StudioIntegration/lufa_extension_transform.xslt
+++ b/LUFA/StudioIntegration/lufa_extension_transform.xslt
@@ -8,6 +8,9 @@
<!-- Atmel Studio framework Extension XML transform file -->
+<!-- Creates an extension.xml document from a given manifest list of XML files,
+ and adds appropriate documentation base URI entries and version
+ information. -->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:output method="xml" omit-xml-declaration="yes"/>
diff --git a/LUFA/StudioIntegration/lufa_filelist_transform.xslt b/LUFA/StudioIntegration/lufa_filelist_transform.xslt
index 758bc9865..103ff51a9 100644
--- a/LUFA/StudioIntegration/lufa_filelist_transform.xslt
+++ b/LUFA/StudioIntegration/lufa_filelist_transform.xslt
@@ -8,6 +8,8 @@
<!-- Atmel Studio framework Module XML transform file -->
+<!-- Outputs a flat file list of all source files referenced in all modules of
+ the input manifest XML file, so that they can be checked for existence. -->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:output method="xml" omit-xml-declaration="yes"/>
diff --git a/LUFA/StudioIntegration/lufa_indent_transform.xslt b/LUFA/StudioIntegration/lufa_indent_transform.xslt
index dccca045c..a05a82427 100644
--- a/LUFA/StudioIntegration/lufa_indent_transform.xslt
+++ b/LUFA/StudioIntegration/lufa_indent_transform.xslt
@@ -8,6 +8,7 @@
<!-- Atmel Studio framework Module XML transform file -->
+<!-- Indents a given XML document to match the node hierarchy. -->
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
diff --git a/LUFA/StudioIntegration/lufa_module_transform.xslt b/LUFA/StudioIntegration/lufa_module_transform.xslt
index 7db09e5ef..e3a0329ea 100644
--- a/LUFA/StudioIntegration/lufa_module_transform.xslt
+++ b/LUFA/StudioIntegration/lufa_module_transform.xslt
@@ -8,6 +8,9 @@
<!-- Atmel Studio framework Module XML transform file -->
+<!-- Creates an asf.xml module document from a given manifest list of XML files,
+ and adds appropriate documentation links by cross-referencing the Doxygen
+ tag output file to map Doxygen group names to generated filenames. -->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:output method="xml" omit-xml-declaration="yes"/>
@@ -21,17 +24,8 @@
<asf xmlversion="1.0">
<xsl:for-each select="xml-source">
-
- <xsl:text>&#xA;&#xA;</xsl:text>
<xsl:comment>Sourced from <xsl:value-of select="@filename"/></xsl:comment>
- <xsl:text>&#xA;</xsl:text>
-
<xsl:apply-templates select="document(@filename)/lufa/asf/*"/>
-
- <xsl:if test="position()=last()">
- <xsl:text>&#xA;&#xA;</xsl:text>
- </xsl:if>
-
</xsl:for-each>
</asf>
</xsl:template>
@@ -43,11 +37,9 @@
</xsl:copy>
</xsl:template>
- <!-- For Doxygen entry point nodes we need to convert them to add additional
- help link nodes so that they show up as links in Studio correctly -->
+ <!-- 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 -->
<xsl:template match="build[@type='doxygen-entry-point']">
- <xsl:copy-of select="current()"/>
-
<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>