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 11:08:39 UTC
svn commit: r797014 - in /incubator/kato/trunk/org.apache.kato/kato.docs: ./
pom.xml src/docbkx/fo.xsl src/docbkx/spec.xml src/xslt/packagecontents.xslt
Author: spoole
Date: Thu Jul 23 11:08:39 2009
New Revision: 797014
URL: http://svn.apache.org/viewvc?rev=797014&view=rev
Log:
updated docs gen to have more info from javadoc
Modified:
incubator/kato/trunk/org.apache.kato/kato.docs/ (props changed)
incubator/kato/trunk/org.apache.kato/kato.docs/pom.xml
incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/fo.xsl
incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml
incubator/kato/trunk/org.apache.kato/kato.docs/src/xslt/packagecontents.xslt
Propchange: incubator/kato/trunk/org.apache.kato/kato.docs/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Thu Jul 23 11:08:39 2009
@@ -0,0 +1 @@
+target
Modified: incubator/kato/trunk/org.apache.kato/kato.docs/pom.xml
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.docs/pom.xml?rev=797014&r1=797013&r2=797014&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.docs/pom.xml (original)
+++ incubator/kato/trunk/org.apache.kato/kato.docs/pom.xml Thu Jul 23 11:08:39 2009
@@ -77,8 +77,9 @@
<xincludeSupported>true</xincludeSupported>
<chunkedOutput>true</chunkedOutput>
<footerRule>true</footerRule>
- <foCustomization>${basedir}/src/docbkx/fo.xsl</foCustomization>
+ <foCustomization>${basedir}/src/docbkx/fo.xsl</foCustomization>
+ <paperType>A4</paperType>
<draftWatermarkImage>http://docbook.sourceforge.net/release/images/draft.png</draftWatermarkImage>
</configuration>
Modified: incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/fo.xsl
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/fo.xsl?rev=797014&r1=797013&r2=797014&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/fo.xsl (original)
+++ incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/fo.xsl Thu Jul 23 11:08:39 2009
@@ -9,7 +9,7 @@
<xsl:import href="urn:docbkx:stylesheet/highlight.xsl"/>
- <!-- some customization -->
+
<xsl:attribute-set name="section.title.level1.properties">
<xsl:attribute name="border-top">0.5pt solid black</xsl:attribute>
<xsl:attribute name="border-bottom">0.5pt solid black</xsl:attribute>
@@ -25,6 +25,8 @@
</xsl:attribute-set>
<xsl:attribute-set name="section.title.level2.properties">
+ <xsl:attribute name="border-top">0.5pt solid black</xsl:attribute>
+ <xsl:attribute name="padding-top">6pt</xsl:attribute>
<xsl:attribute name="font-size">
<xsl:value-of select="$body.font.master * 1.728"></xsl:value-of>
<xsl:text>pt</xsl:text>
@@ -37,11 +39,12 @@
<xsl:text>pt</xsl:text>
</xsl:attribute>
</xsl:attribute-set>
-<!--
-<xsl:attribute-set name="section.level2.properties">
- <xsl:attribute name="break-before">page</xsl:attribute>
-</xsl:attribute-set>
- -->
+<xsl:attribute-set name="section.title.level4.properties">
+ <xsl:attribute name="font-size">
+ <xsl:value-of select="$body.font.master"></xsl:value-of>
+ <xsl:text>pt</xsl:text>
+ </xsl:attribute>
+</xsl:attribute-set>
</xsl:stylesheet>
Modified: incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml?rev=797014&r1=797013&r2=797014&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml (original)
+++ incubator/kato/trunk/org.apache.kato/kato.docs/src/docbkx/spec.xml Thu Jul 23 11:08:39 2009
@@ -22,15 +22,18 @@
</para>
</legalnotice>
-
-
</info>
+
<preface>
<title>Preface</title>
-
+<warning>
+<para>
+This is a living document. Make sure you have the latest copy.
+</para>
+</warning>
<section>
<title>Audience</title>
</section>
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=797014&r1=797013&r2=797014&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 11:08:39 2009
@@ -1,156 +1,237 @@
<?xml version="1.0"?>
-<xsl:stylesheet version="1.0"
-xmlns:html="http://www.w3.org/1999/xhtml"
-xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-xmlns:fo="http://www.w3.org/1999/XSL/Format"
-xmlns:db="http://docbook.org/ns/docbook"
-xmlns:javadoc="http://apache.org/javadoc"
-xmlns="http://docbook.org/ns/docbook">
-
-<xsl:template match="/">
-
-<chapter version="5.0" xml:id="api-reference">
- <title>API Reference</title>
- <para>This chapter contains the details of the Java classes that comprise the API.</para>
- <xsl:for-each select="javadoc:javadoc/javadoc:package">
- <xsl:sort select="@name"/>
-
- <sect1>
-
- <xsl:attribute name="xml:id">
+<xsl:stylesheet version="1.0" xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format"
+ xmlns:db="http://docbook.org/ns/docbook" xmlns:javadoc="http://apache.org/javadoc"
+ xmlns="http://docbook.org/ns/docbook">
+
+ <xsl:template match="/">
+
+ <chapter version="5.0" xml:id="api-reference">
+ <title>API Reference</title>
+ <para>This chapter contains the details of the Java classes that
+ comprise the API.</para>
+ <xsl:for-each select="javadoc:javadoc/javadoc:package">
+ <xsl:sort select="@name" />
+
+ <sect1>
+
+ <xsl:attribute name="xml:id">
<xsl:value-of select="@name" />
</xsl:attribute>
-
-
- <title><xsl:value-of select="@name"/></title>
- <section>
- <xsl:copy-of select="javadoc:comment/*"/>
- </section>
- <xsl:if test="count(./javadoc:interface)>0">
-
- <table border="1">
- <xsl:attribute name="xml:id">interfacelist.
- <xsl:value-of select="@name" />
- </xsl:attribute>
- <caption>Interface Summary</caption>
- <thead>
- <tr>
- <th colspan="1">Name</th>
- <th colspan="2">Summary</th>
- </tr>
- </thead>
- <tbody>
-
- <xsl:for-each select="./javadoc:interface">
-
- <tr>
- <td colspan="1"><xsl:value-of select="@name"/></td>
- <td colspan="2"><xsl:value-of select="javadoc:summary"/></td>
- </tr>
-
- </xsl:for-each>
- </tbody>
- </table>
- </xsl:if>
-
- <xsl:if test="count(./javadoc:class)>0">
- <table border="1">
- <xsl:attribute name="xml:id">classlist.
+
+
+ <title>
+ package
+ <xsl:value-of select="@name" />
+ </title>
+ <section>
+ <xsl:copy-of select="javadoc:comment/*" />
+ </section>
+ <xsl:if test="count(./javadoc:interface)>0">
+
+ <table border="1">
+ <xsl:attribute name="xml:id">interfacelist.
<xsl:value-of select="@name" />
</xsl:attribute>
- <caption>Class Summary</caption>
- <thead>
- <tr bgcolor="red">
- <td>Name</td>
- <td>Summary</td>
- </tr>
- </thead>
- <tbody>
- <xsl:for-each select="./javadoc:class">
- <tr>
- <td><xsl:value-of select="@name"/></td>
- <td><xsl:value-of select="javadoc:summary"/></td>
- </tr>
- </xsl:for-each>
- </tbody>
- </table>
- </xsl:if>
-
-
-
- <!-- list class details -->
- <xsl:if test="count(./javadoc:interface | ./javadoc:class)>0">
- <sect2>
- <title>Details</title>
- <xsl:for-each select="./javadoc:class | ./javadoc:interface">
- <sect3>
- <title><xsl:value-of select="@name"/></title>
- <section><xsl:copy-of select="comment/*"/></section>
- <xsl:if test="count(./javadoc:field)>0">
- <xsl:for-each select="./javadoc:field">
- <para>Field</para>
- </xsl:for-each>
- </xsl:if>
- <xsl:if test="count(./javadoc:constructor)>0">
- <table border="1">
- <xsl:attribute name="xml:id">constructors.
+
+ <caption>Interface Summary</caption>
+ <tgroup cols='3' align='left' colsep='1' rowsep='1'>
+ <colspec colname='c1' />
+ <colspec colname='c2' />
+ <colspec colname='c3' />
+ <thead>
+ <row>
+ <xsl:processing-instruction name="dbfo">
+ bgcolor="#CCCCFF"
+ </xsl:processing-instruction>
+ <entry>Name</entry>
+ <entry namest="c2" nameend="c3">Summary</entry>
+ </row>
+ </thead>
+ <tbody>
+ <xsl:for-each select="./javadoc:interface">
+ <row>
+ <entry>
+ <xsl:value-of select="@name" />
+ </entry>
+ <entry namest="c2" nameend="c3">
+ <xsl:value-of select="javadoc:summary" />
+ </entry>
+ </row>
+ </xsl:for-each>
+ </tbody>
+ </tgroup>
+ </table>
+ </xsl:if>
+
+ <xsl:if test="count(./javadoc:class)>0">
+ <table border="1">
+ <xsl:attribute name="xml:id">classlist.
<xsl:value-of select="@name" />
</xsl:attribute>
- <caption>Constructor Summary</caption>
- <thead>
- <tr bgcolor="red">
- <td>Signature</td>
- <td>Summary</td>
- </tr>
- </thead>
- <tbody>
- <xsl:for-each select="./javadoc:constructor">
- <tr>
- <td><xsl:value-of select="../@name"/><xsl:value-of select="@signature"/></td>
- <td><xsl:value-of select="javadoc:summary"/></td>
- </tr>
- </xsl:for-each>
- </tbody>
- </table>
- </xsl:if>
- <xsl:if test="count(./javadoc:method)>0">
- <table border="1">
- <xsl:attribute name="xml:id">methods.
+
+ <caption>Class Summary</caption>
+ <tgroup cols='3' align='left' colsep='1' rowsep='1'>
+ <colspec colname='c1' />
+ <colspec colname='c2' />
+ <colspec colname='c3' />
+ <thead>
+ <row>
+ <xsl:processing-instruction name="dbfo">
+ bgcolor="#CCCCFF"
+ </xsl:processing-instruction>
+ <entry>Name</entry>
+ <entry namest="c2" nameend="c3">Summary</entry>
+ </row>
+ </thead>
+ <tbody>
+ <xsl:for-each select="./javadoc:class">
+ <row>
+ <entry>
+ <xsl:value-of select="@name" />
+ </entry>
+ <entry namest="c2" nameend="c3">
+ <xsl:value-of select="javadoc:summary" />
+ </entry>
+ </row>
+ </xsl:for-each>
+ </tbody>
+ </tgroup>
+ </table>
+ </xsl:if>
+
+
+
+ <!-- list class details -->
+ <xsl:if test="count(./javadoc:interface | ./javadoc:class)>0">
+ <sect2>
+ <title>Details</title>
+ <xsl:for-each select="./javadoc:class | ./javadoc:interface">
+
+ <sect3>
+ <title>
+ <xsl:value-of select="local-name()" />
+ <xsl:text> </xsl:text>
+ <xsl:value-of select="@name" />
+ </title>
+ <xsl:if test="javadoc:extends">
+ <sect4>
+ <title>
+ Extends
+ <xsl:value-of select="javadoc:extends" />
+ </title>
+ </sect4>
+ </xsl:if>
+ <sect4>
+ <title>All Implemented Interfaces</title>
+ </sect4>
+ <sect4>
+ <title>Direct known subclasses</title>
+ </sect4>
+ <para>
+ <xsl:value-of select="javadoc:modifiers" />
+ <xsl:text> </xsl:text>
+ <xsl:value-of select="@name" />
+ </para>
+ <para>Extends
+ </para>
+ <para>Implements
+ </para>
+ <section>
+ <xsl:copy-of select="comment/*" />
+ </section>
+ <xsl:if test="count(./javadoc:field)>0">
+ <xsl:for-each select="./javadoc:field">
+ <para>Field</para>
+ </xsl:for-each>
+ </xsl:if>
+ <xsl:if test="count(./javadoc:constructor)>0">
+ <table border="1">
+ <xsl:attribute name="xml:id">constructors.
<xsl:value-of select="@name" />
</xsl:attribute>
- <caption>Method Summary</caption>
- <thead>
- <tr bgcolor="red">
- <td>Return Type</td>
- <td>Signature</td>
- <td>Summary</td>
- </tr>
- </thead>
- <tbody>
-
- <xsl:for-each select="./javadoc:method">
- <tr>
- <td><xsl:value-of select="javadoc:modifiers"/><xsl:text> </xsl:text><xsl:value-of select="javadoc:returntype/javadoc:name"/></td>
- <td><xsl:value-of select="@name"/><xsl:value-of select="@signature"/></td>
- <td><xsl:value-of select="javadoc:summary"/></td>
- </tr>
- </xsl:for-each>
- </tbody>
- </table>
- </xsl:if>
- </sect3>
-
- </xsl:for-each>
- </sect2>
- </xsl:if>
-
- </sect1>
- </xsl:for-each>
-
-</chapter>
-
+ <caption>Constructor Summary</caption>
+ <thead>
+ <tr>
+ <td>Signature</td>
+ <td>Summary</td>
+ </tr>
+ </thead>
+ <tbody>
+ <xsl:for-each select="./javadoc:constructor">
+ <tr>
+ <td>
+ <xsl:value-of select="../@name" />
+ <xsl:value-of select="@signature" />
+ </td>
+ <td>
+ <xsl:value-of select="javadoc:summary" />
+ </td>
+ </tr>
+ </xsl:for-each>
+ </tbody>
+ </table>
+ </xsl:if>
+ <xsl:if test="count(./javadoc:method)>0">
+ <table border="1">
+ <caption>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' />
+ <thead>
+ <row>
+ <xsl:processing-instruction
+ name="dbfo">
+ bgcolor="#CCCCFF"
+ </xsl:processing-instruction>
+ <entry>Method</entry>
+ <entry namest="c2" nameend="c5">Summary</entry>
+ </row>
+ </thead>
+ <tbody>
+
+ <xsl:for-each select="./javadoc:method">
+ <row>
+ <entry>
+ <xsl:value-of select="javadoc:modifiers" />
+ <xsl:text> </xsl:text>
+ <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>
+ <xsl:text>(</xsl:text>
+ <xsl:if test="javadoc:parameters">
+ <xsl:for-each select="javadoc:parameters/javadoc:parameter">
+ <xsl:value-of select="@type" />
+ <xsl:text> </xsl:text>
+ <xsl:value-of select="@name" />
+ </xsl:for-each>
+ </xsl:if>
+ <xsl:text>)</xsl:text>
+ </para>
+ <para>
+ <xsl:value-of select="javadoc:summary" />
+ </para>
+ </entry>
+ </row>
+ </xsl:for-each>
+ </tbody>
+ </tgroup>
+ </table>
+ </xsl:if>
+ </sect3>
+
+ </xsl:for-each>
+ </sect2>
+ </xsl:if>
+ </sect1>
+ </xsl:for-each>
+ </chapter>
</xsl:template>
-
-
</xsl:stylesheet>
\ No newline at end of file