aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-04-08 18:59:25 +0000
committerDean Camera <dean@fourwalledcubicle.com>2013-04-08 18:59:25 +0000
commitebd059d0eb07055d3d949f53ba284e23eac23bc6 (patch)
treefebfb1e7d1c1b7b4d8c2b806c06675e9ce3428d9 /LUFA
parentc2f9eba33f9ca8a7254b0f38b243ffa6e2b1d19c (diff)
downloadlufa-ebd059d0eb07055d3d949f53ba284e23eac23bc6.tar.gz
lufa-ebd059d0eb07055d3d949f53ba284e23eac23bc6.tar.bz2
lufa-ebd059d0eb07055d3d949f53ba284e23eac23bc6.zip
Update AS integration scripts and transforms - extract out the module description from the Doxygen XML output for the GUI.
Diffstat (limited to 'LUFA')
-rw-r--r--LUFA/Doxygen.conf2
-rw-r--r--LUFA/DoxygenPages/ChangeLog.txt2
-rw-r--r--LUFA/StudioIntegration/XSLT/lufa_module_transform.xslt23
-rw-r--r--LUFA/StudioIntegration/makefile14
4 files changed, 23 insertions, 18 deletions
diff --git a/LUFA/Doxygen.conf b/LUFA/Doxygen.conf
index e8d5e5c8d..af74d44d3 100644
--- a/LUFA/Doxygen.conf
+++ b/LUFA/Doxygen.conf
@@ -1643,7 +1643,7 @@ TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
-GENERATE_TAGFILE = Documentation/lufa_doc_tags.xml
+GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
diff --git a/LUFA/DoxygenPages/ChangeLog.txt b/LUFA/DoxygenPages/ChangeLog.txt
index e94b78818..fb05dd63d 100644
--- a/LUFA/DoxygenPages/ChangeLog.txt
+++ b/LUFA/DoxygenPages/ChangeLog.txt
@@ -49,7 +49,7 @@
* - Increased throughput in the USBtoSerial project now that data transmission is non-blocking (thanks to Joseph Lacerte)
* - Updated bootloader makefiles to remove dependency on the \c bc command line calculator tool
* - Updated AVRISP-MKII Clone Programmer project so that the SCK clock period is saved in EEPROM (thanks to Gerhard Wesser)
- * - Changed all *_SendByte() function prototypes to accept a void pointer for the input buffer (thanks to Simon Küppers)
+ * - Changed all *_SendByte() function prototypes to accept a void pointer for the input buffer (thanks to Simon Kuppers)
*
* <b>Fixed:</b>
* - Core:
diff --git a/LUFA/StudioIntegration/XSLT/lufa_module_transform.xslt b/LUFA/StudioIntegration/XSLT/lufa_module_transform.xslt
index 65ff2f0b0..9146202a4 100644
--- a/LUFA/StudioIntegration/XSLT/lufa_module_transform.xslt
+++ b/LUFA/StudioIntegration/XSLT/lufa_module_transform.xslt
@@ -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>
diff --git a/LUFA/StudioIntegration/makefile b/LUFA/StudioIntegration/makefile
index e895a41e4..8c0595f65 100644
--- a/LUFA/StudioIntegration/makefile
+++ b/LUFA/StudioIntegration/makefile
@@ -11,6 +11,7 @@
LUFA_ROOT := ..
DOXYGEN_TAG_FILE_XML := $(LUFA_ROOT)/Documentation/lufa_doc_tags.xml
+DOXYGEN_COMBINED_XML := $(LUFA_ROOT)/Documentation/xml/lufa_doc.xml
TEMP_MANIFEST_XML := manifest.xml
EXTENSION_OUTPUT_XML := $(LUFA_ROOT)/../extension.xml
MODULE_OUTPUT_XML := $(LUFA_ROOT)/asf.xml
@@ -21,7 +22,7 @@ ifneq ($(LUFA_VERSION_NUM),000000)
EXT_VERSION_NUM := $(shell date +"%y.%m.%d").$(LUFA_VERSION_NUM)
EXT_VSIX_NAME := LUFA-RELEASE-$(LUFA_VERSION_NUM).vsix
else
- EXT_VERSION_NUM := 0.$(shell date +"%y%m%d.%H%M%S")
+ EXT_VERSION_NUM := 0.$(shell date +"%y%m%d-%H%M%S")
EXT_VSIX_NAME := LUFA-TESTING-$(shell date +"%y.%m.%d.%H.%M.%S").vsix
$(warning No LUFA version set - assuming a test version should be created.)
@@ -30,15 +31,18 @@ endif
all: generate_xml check_filenames generate_vsix
clean:
- @rm -f $(TEMP_MANIFEST_XML) $(MODULE_OUTPUT_XML) $(EXTENSION_OUTPUT_XML)
+ @rm -f $(TEMP_MANIFEST_XML) $(MODULE_OUTPUT_XML) $(EXTENSION_OUTPUT_XML) $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML)
$(DOXYGEN_TAG_FILE_XML):
- $(MAKE) -C ../ doxygen
+ $(MAKE) -C ../ doxygen DOXYGEN_OVERRIDE_PARAMS="GENERATE_TAGFILE=Documentation/lufa_doc_tags.xml GENERATE_XML=yes"
-$(TEMP_MANIFEST_XML): $(DOXYGEN_TAG_FILE_XML)
+$(DOXYGEN_COMBINED_XML): $(DOXYGEN_TAG_FILE_XML)
+ @xsltproc $(dir $@)/combine.xslt $(dir $@)/index.xml > $(DOXYGEN_COMBINED_XML)
+
+$(TEMP_MANIFEST_XML): $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML)
@echo "Generating Manifest XML..."
- @printf "<lufa-manifest version=\"%s\" tagfile=\"%s\">\n" $(LUFA_VERSION_NUM) $(DOXYGEN_TAG_FILE_XML) > $@
+ @printf "<lufa-manifest version=\"%s\" tagfile=\"%s\" docfile=\"%s\">\n" $(LUFA_VERSION_NUM) $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML) > $@
@for i in $(XML_FILES); do \
printf "\t<xml-source filename=\"%s\"/>\n" $$i >> $@; \
done;