projects / pub / USBasp.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: cc44591)
Update Doxygen-to-Docbook transform with the latest transform rules for functions...
authorDean Camera <dean@fourwalledcubicle.com>
Mon, 22 Apr 2013 19:22:27 +0000 (19:22 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Mon, 22 Apr 2013 19:22:27 +0000 (19:22 +0000)
LUFA/StudioIntegration/Blob/LUFA.dll patch | blob | blame | history
LUFA/StudioIntegration/HV1/helpcontentsetup.msha patch | blob | blame | history
LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl patch | blob | blame | history
LUFA/StudioIntegration/HV1/lufa_studio_help_styling.css patch | blob | blame | history

diff --git a/LUFA/StudioIntegration/Blob/LUFA.dll b/LUFA/StudioIntegration/Blob/LUFA.dll
index a96fa98..2a23ed6 100644 (file)
Binary files a/LUFA/StudioIntegration/Blob/LUFA.dll and b/LUFA/StudioIntegration/Blob/LUFA.dll differ
diff --git a/LUFA/StudioIntegration/HV1/helpcontentsetup.msha b/LUFA/StudioIntegration/HV1/helpcontentsetup.msha
index 8bf5543..cb1c4b9 100644 (file)
--- a/LUFA/StudioIntegration/HV1/helpcontentsetup.msha
+++ b/LUFA/StudioIntegration/HV1/helpcontentsetup.msha
@@ -1,3 +1,11 @@
+<!--
+             LUFA Library
+     Copyright (C) Dean Camera, 2013.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+-->
+
 <html xmlns="http://www.w3.org/1999/xhtml">
        <head>
                <title>LUFA Help</title>
 <html xmlns="http://www.w3.org/1999/xhtml">
        <head>
                <title>LUFA Help</title>
diff --git a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl
index c1b6b2d..dbbc64b 100644 (file)
--- a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl
+++ b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xsl
@@ -182,8 +182,14 @@
 
                <section id="{@id}" xreflabel="{$name}">
                        <title>
 
                <section id="{@id}" xreflabel="{$name}">
                        <title>
-                               <xsl:value-of select="@kind"/>
-                               <xsl:text> </xsl:text>
+                               <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="$name"/>
                        </title>
 
                                <xsl:value-of select="$name"/>
                        </title>
 
@@ -194,7 +200,7 @@
                        <xsl:apply-templates select="detaileddescription"/>
 
                        <xsl:for-each select="sectiondef[@kind='public-attrib']">
                        <xsl:apply-templates select="detaileddescription"/>
 
                        <xsl:for-each select="sectiondef[@kind='public-attrib']">
-                               <table abstyle="striped">
+                               <table tabstyle="striped">
                                        <title>
                                                <xsl:value-of select="$name"/>
                                        </title>
                                        <title>
                                                <xsl:value-of select="$name"/>
                                        </title>
@@ -204,8 +210,8 @@
                                                <spanspec spanname="full" namest="start.col" nameend="stop.col"/>
                                                <thead>
                                                        <row>
                                                <spanspec spanname="full" namest="start.col" nameend="stop.col"/>
                                                <thead>
                                                        <row>
-                                                               <entry>Data type</entry>
-                                                               <entry>Field name</entry>
+                                                               <entry>Type</entry>
+                                                               <entry>Name</entry>
                                                                <entry>Description</entry>
                                                        </row>
                                                </thead>
                                                                <entry>Description</entry>
                                                        </row>
                                                </thead>
@@ -217,6 +223,9 @@
                                                                        </entry>
                                                                        <entry>
                                                                                <xsl:value-of select="name"/>
                                                                        </entry>
                                                                        <entry>
                                                                                <xsl:value-of select="name"/>
+                                                                               <xsl:if test="starts-with(argsstring, '[')">
+                                                                                       <xsl:text>[]</xsl:text>
+                                                                               </xsl:if>
                                                                                <indexterm id="{$keyword.namespace}.{$name}.{name}"/>
                                                                        </entry>
                                                                        <entry>
                                                                                <indexterm id="{$keyword.namespace}.{$name}.{name}"/>
                                                                        </entry>
                                                                        <entry>
@@ -252,9 +261,34 @@
                        </para>
 
                        <programlisting language="c">
                        </para>
 
                        <programlisting language="c">
-                               <xsl:value-of select="definition"/>
-                               <xsl:text> </xsl:text>
-                               <xsl:apply-templates select="argsstring"/>
+                               <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"/>
                        </programlisting>
 
                        <xsl:apply-templates select="detaileddescription"/>
@@ -276,7 +310,8 @@
 
                        <xsl:apply-templates select="detaileddescription"/>
 
 
                        <xsl:apply-templates select="detaileddescription"/>
 
-                       <informaltable tabstyle="striped">
+                       <table tabstyle="striped">
+                               <title>Members</title>
                                <tgroup cols="2">
                                        <thead>
                                                <row>
                                <tgroup cols="2">
                                        <thead>
                                                <row>
@@ -299,7 +334,7 @@
                                                </xsl:for-each>
                                        </tbody>
                                </tgroup>
                                                </xsl:for-each>
                                        </tbody>
                                </tgroup>
-                       </informaltable>
+                       </table>
                </section>
        </xsl:template>
 
                </section>
        </xsl:template>
 
@@ -317,27 +352,29 @@
                        </xsl:call-template>
 
                        <programlisting language="c">
                        </xsl:call-template>
 
                        <programlisting language="c">
-                               <xsl:text>#define </xsl:text>
-                               <xsl:value-of select="name"/>
-                               <xsl:if test="count(param) &gt; 0">
-                                       <xsl:text>(</xsl:text>
-                                       <xsl:for-each select="param/defname">
-                                               <xsl:if test="position() &gt; 1">
-                                                       <xsl:text>,</xsl:text>
-                                               </xsl:if>
-                                               <xsl:value-of select="."/>
-                                       </xsl:for-each>
-                                       <xsl:text>)</xsl:text>
-                               </xsl:if>
-
-                               <xsl:text> </xsl:text>
+                               <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) &gt; 50) or (count(param) &gt; 0)">
-                                       <xsl:text>\</xsl:text>
-                               </xsl:if>
+                                       <!-- 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"/>
+                                       <xsl:value-of select="initializer"/>
+                               </emphasis>
+                               <xsl:text> </xsl:text>
                        </programlisting>
 
                        <xsl:apply-templates select="detaileddescription"/>
                        </programlisting>
 
                        <xsl:apply-templates select="detaileddescription"/>
@@ -348,29 +385,51 @@
                <xsl:variable name="name" select="name"/>
 
                <section id="{@id}" xreflabel="{name}">
                <xsl:variable name="name" select="name"/>
 
                <section id="{@id}" xreflabel="{name}">
-                       <title>
-                               <!-- 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')">
+                       <!-- 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>
                                                <xsl:text>Type </xsl:text>
                                                <xsl:text>Type </xsl:text>
-                                       </xsl:when>
-                                       <xsl:otherwise>
-                                               <xsl:text>Variable </xsl:text>
-                                       </xsl:otherwise>
-                               </xsl:choose>
+                                               <xsl:value-of select="name"/>
+                                       </title>
 
 
-                               <xsl:value-of select="name"/>
-                       </title>
+                                       <xsl:call-template name="generate.index.id">
+                                               <xsl:with-param name="name" select="$name"/>
+                                       </xsl:call-template>
 
 
-                       <xsl:call-template name="generate.index.id">
-                               <xsl:with-param name="name" select="$name"/>
-                       </xsl:call-template>
+                                       <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>
 
 
-                       <programlisting language="c">
-                               <xsl:value-of select="definition"/>
-                       </programlisting>
+                               <xsl:otherwise>
+                                       <title>
+                                               <xsl:text>Variable </xsl:text>
+                                               <xsl:value-of select="name"/>
+                                       </title>
+
+                                       <xsl:call-template name="generate.index.id">
+                                               <xsl:with-param name="name" select="$name"/>
+                                       </xsl:call-template>
+
+                                       <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"/>
                </section>
 
                        <xsl:apply-templates select="detaileddescription"/>
                </section>
diff --git a/LUFA/StudioIntegration/HV1/lufa_studio_help_styling.css b/LUFA/StudioIntegration/HV1/lufa_studio_help_styling.css
index cfc835e..892c0ef 100644 (file)
--- a/LUFA/StudioIntegration/HV1/lufa_studio_help_styling.css
+++ b/LUFA/StudioIntegration/HV1/lufa_studio_help_styling.css
@@ -1,3 +1,11 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2013.\r
+\r
+  dean [at] fourwalledcubicle [dot] com\r
+           www.lufa-lib.org\r
+*/\r
+\r
 .programlisting {\r
        display: block;\r
        margin-left: 15px;\r
 .programlisting {\r
        display: block;\r
        margin-left: 15px;\r
USB isp AVR programmer