You are viewing a plain text version of this content. The canonical link for it is here.
Posted to kato-commits@incubator.apache.org by sp...@apache.org on 2009/07/23 15:54:52 UTC
svn commit: r797119 - in
/incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt:
packagecontents.xslt packagelist.xslt
Author: spoole
Date: Thu Jul 23 15:54:51 2009
New Revision: 797119
URL: http://svn.apache.org/viewvc?rev=797119&view=rev
Log:
more style work on spec doc
Modified:
incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagecontents.xslt
incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagelist.xslt
Modified: incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagecontents.xslt
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagecontents.xslt?rev=797119&r1=797118&r2=797119&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagecontents.xslt (original)
+++ incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagecontents.xslt Thu Jul 23 15:54:51 2009
@@ -19,8 +19,7 @@
<xsl:attribute name="xml:id">
<xsl:value-of select="@name" />
</xsl:attribute>
-
-
+ <xsl:processing-instruction name="dbfo-need">height="4in"</xsl:processing-instruction>
<title><xsl:text>package </xsl:text>
<xsl:value-of select="@name" />
</title>
@@ -29,11 +28,13 @@
</section>
<xsl:if test="count(./javadoc:interface)>0">
- <table border="1">
+ <table border="1" pgwide="1">
<xsl:attribute name="xml:id">interfacelist.
<xsl:value-of select="@name" />
</xsl:attribute>
-
+ <xsl:processing-instruction name="dbfo">
+ keep-together="auto"
+ </xsl:processing-instruction>
<caption>Interface Summary</caption>
<tgroup cols='3' align='left' colsep='1' rowsep='1'>
<colspec colname='c1' />
@@ -65,11 +66,13 @@
</xsl:if>
<xsl:if test="count(./javadoc:class)>0">
- <table border="1">
+ <table border="1" pgwide="1">
<xsl:attribute name="xml:id">classlist.
<xsl:value-of select="@name" />
- </xsl:attribute>
-
+ </xsl:attribute>
+ <xsl:processing-instruction name="dbfo">
+ keep-together="auto"
+ </xsl:processing-instruction>
<caption>Class Summary</caption>
<tgroup cols='3' align='left' colsep='1' rowsep='1'>
<colspec colname='c1' />
@@ -109,6 +112,7 @@
<xsl:for-each select="./javadoc:class | ./javadoc:interface">
<sect3>
+ <xsl:processing-instruction name="dbfo-need">height="4in"</xsl:processing-instruction>
<title>
<xsl:value-of select="local-name()" />
<xsl:text> </xsl:text>
@@ -123,8 +127,6 @@
<xsl:value-of select="javadoc:extends" />
</xsl:if>
</para>
-
- <para>Description</para>
<para>
<xsl:copy-of select="javadoc:comment/*" />
</para>
@@ -134,13 +136,19 @@
</xsl:for-each>
</xsl:if>
<xsl:if test="count(./javadoc:constructor)>0">
- <table border="1">
+ <table border="1" pgwide="1">
<xsl:attribute name="xml:id">constructors.
<xsl:value-of select="@name" />
</xsl:attribute>
+ <xsl:processing-instruction name="dbfo">
+ keep-together="auto"
+ </xsl:processing-instruction>
<caption><xsl:value-of select="@name" /> Constructor Summary</caption>
<thead>
- <tr>
+ <tr><xsl:processing-instruction
+ name="dbfo">
+ bgcolor="#CCCCFF"
+ </xsl:processing-instruction>
<td>Signature</td>
<td>Summary</td>
</tr>
@@ -160,38 +168,61 @@
</tbody>
</table>
</xsl:if>
+
+ <!-- List Methods -->
+
<xsl:if test="count(./javadoc:method)>0">
- <table border="1">
- <caption><xsl:value-of select="@name" /> Method Summary</caption>
- <tgroup cols='5' align='left' colsep='1' rowsep='1'>
- <colspec colname='c1' />
- <colspec colname='c2' />
- <colspec colname='c3' />
- <colspec colname='c4' />
- <colspec colname='c5' />
+ <table border="1" pgwide="1">
+ <xsl:processing-instruction name="dbfo">
+ keep-together="auto"
+ </xsl:processing-instruction>
+ <caption><xsl:value-of select="@name" /> Methods</caption>
+ <tgroup cols='10' align='left' colsep='1' rowsep='1'>
+ <colspec colname='a' />
+ <colspec colname='b' />
+ <colspec colname='c' />
+ <colspec colname='d' />
+ <colspec colname='e' />
+ <colspec colname='f' />
+ <colspec colname='g' />
+ <colspec colname='h' />
+ <colspec colname='i' />
+ <colspec colname='j' />
<thead>
<row>
<xsl:processing-instruction
name="dbfo">
bgcolor="#CCCCFF"
</xsl:processing-instruction>
- <entry>Method</entry>
- <entry namest="c2" nameend="c5">Summary</entry>
+ <entry namest="a" nameend="j">Methods</entry>
</row>
</thead>
<tbody>
<xsl:for-each select="./javadoc:method">
<row>
- <entry>
+ <entry namest="a" nameend="c">
+ <command><xsl:value-of select="@name" /></command>
+ </entry>
+
+ <!-- write out details of method.
+ Signature
+ Comments
+ Parameters
+ Returns
+ Throws
+ -->
+
+ <entry namest="d" nameend="j">
+ <!-- signature -->
<xsl:value-of select="javadoc:modifiers" />
<xsl:text> </xsl:text>
+ <!-- return type -->
<xsl:value-of select="javadoc:returntype/javadoc:name" />
<xsl:text> </xsl:text>
- </entry>
- <entry namest="c2" nameend="c5">
- <para>
- <command><xsl:value-of select="@name" /></command>
+ <!-- name -->
+ <xsl:value-of select="@name" />
+ <!-- parameters -->
<xsl:text>(</xsl:text>
<xsl:if test="javadoc:parameters">
<xsl:for-each select="javadoc:parameters/javadoc:parameter">
@@ -201,10 +232,58 @@
</xsl:for-each>
</xsl:if>
<xsl:text>)</xsl:text>
- </para>
+ <!-- comments -->
<para>
- <xsl:value-of select="javadoc:summary" />
+ <xsl:value-of select="javadoc:comment" />
</para>
+
+ <!-- returns -->
+ <xsl:if test="count(./javadoc:returns/javadoc:return)>0">
+ <section>
+ <informaltable frame="none">
+ <tgroup cols='1' align='left' colsep='0' rowsep='0'>
+ <colspec name="a"/>
+ <thead>
+ <row><entry>Returns</entry></row>
+ </thead>
+ <tbody>
+
+ <xsl:for-each select="./javadoc:returns/javadoc:return">
+ <row>
+ <entry><xsl:value-of select="."/></entry>
+ </row>
+ </xsl:for-each>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ </xsl:if>
+ <!-- parameters -->
+ <xsl:if test="count(./javadoc:paramdescs/javadoc:paramdesc)>0">
+ <section>
+ <informaltable>
+ <tgroup cols='5' align='left' colsep='1' rowsep='1'>
+ <colspec name="a"/>
+ <colspec name="b"/>
+ <colspec name="c"/>
+ <colspec name="d"/>
+ <colspec name="e"/>
+ <thead>
+ <row><entry namest="a" nameend="e">Parameters</entry></row>
+ </thead>
+ <tbody>
+
+ <xsl:for-each select="./javadoc:paramdescs/javadoc:paramdesc">
+ <row>
+ <entry><xsl:value-of select="@name" /></entry>
+ <entry namest="b" nameend="e"><xsl:value-of select="."/></entry>
+ </row>
+ </xsl:for-each>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ </xsl:if>
</entry>
</row>
</xsl:for-each>
Modified: incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagelist.xslt
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagelist.xslt?rev=797119&r1=797118&r2=797119&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagelist.xslt (original)
+++ incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagelist.xslt Thu Jul 23 15:54:51 2009
@@ -12,12 +12,13 @@
<db:section version="5.0" xml:id="packages" >
- <table table-layout="fixed" frame='all' id="packagelist"><title>Packages</title>
+ <table table-layout="fixed" frame='all' id="packagelist" pgwide="1"><title>Packages</title>
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<thead>
<row>
+ <xsl:processing-instruction name="dbfo">bgcolor="#CCCCFF"</xsl:processing-instruction>
<entry>Name</entry>
<entry>Title</entry>
</row>
@@ -27,7 +28,7 @@
<xsl:for-each select="javadoc:javadoc/javadoc:package">
<row>
- <entry><para><xsl:value-of select="@name"/></para>para></entry>
+ <entry><para><xsl:value-of select="@name"/></para></entry>
<entry><para><xsl:value-of select="summary"/></para></entry>
</row>
</xsl:for-each>