cziegeler 2003/07/02 13:21:38
Modified: src/targets docs-build.xml
tools/src blocks-build.xsl
Log:
Now the javadocs contains all sources from all blocks
Revision Changes Path
1.20 +10 -5 cocoon-2.1/src/targets/docs-build.xml
Index: docs-build.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/targets/docs-build.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- docs-build.xml 2 Jul 2003 09:30:54 -0000 1.19
+++ docs-build.xml 2 Jul 2003 20:21:37 -0000 1.20
@@ -71,7 +71,7 @@
</target>
<!-- Create docs -->
- <target name="docs" depends="validate-jars, prepare-docs, validate-xdocs,
docs_done, forrest" unless="docs.notrequired" description="Builds the documentation">
+ <target name="docs" depends="validate-jars, prepare-docs, validate-xdocs,
docs_done, forrest, javadocs" unless="docs.notrequired" description="Builds the
documentation">
<!-- The docs are created using forrest, so we simply copy them for now -->
<mkdir dir="${build.docs}"/>
@@ -153,6 +153,7 @@
</target>
<!-- Check if javadocs have to be generated -->
+ <!-- Obsolete:
<target name="javadocs-check">
<mkdir dir="${build.javadocs}"/>
<condition property="javadocs.notrequired" value="true">
@@ -165,8 +166,9 @@
</or>
</condition>
</target>
-
+ -->
<!-- Creates Javadocs -->
+ <!-- Obsolete:
<target name="javadocs" depends="prepare, javadocs-check"
unless="javadocs.notrequired" description="Builds the API documentation (javadocs)">
<condition property="javadoc.additionalparam" value="-breakiterator -tag
todo:all:Todo:">
@@ -205,9 +207,12 @@
</javadoc>
</target>
-
- <!-- build the javadocs of the blocks -->
- <target name="blocks-javadocs" depends="javadocs,prepare-blocks">
+ -->
+
+ <!-- Creates Javadocs -->
+ <target name="javadocs"
+ depends="prepare-blocks"
+ description="Builds the API documentation (javadocs)">
<ant antfile="${build.temp}/blocks-build.xml"
inheritAll="true"
inheritRefs="false"
1.27 +67 -51 cocoon-2.1/tools/src/blocks-build.xsl
Index: blocks-build.xsl
===================================================================
RCS file: /home/cvs/cocoon-2.1/tools/src/blocks-build.xsl,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -r1.26 -r1.27
--- blocks-build.xsl 2 Jul 2003 09:30:54 -0000 1.26
+++ blocks-build.xsl 2 Jul 2003 20:21:38 -0000 1.27
@@ -65,6 +65,73 @@
<xsl:attribute name="depends">init<xsl:for-each
select="project[contains(@name,'cocoon-block-')]"><xsl:text>,</xsl:text><xsl:value-of
select="@name"/>-tests</xsl:for-each></xsl:attribute>
</target>
+ <!-- Check if javadocs have to be generated -->
+ <target name="javadocs-check">
+ <mkdir dir="{string('${build.javadocs}')}"/>
+ <condition property="javadocs.notrequired" value="true">
+ <or>
+ <uptodate targetfile="{string('${build.javadocs}')}/packages.html" >
+ <srcfiles dir="{string('${java}')}"
includes="**/*.java,**/package.html"/>
+ <srcfiles dir="{string('${deprecated.src}')}"
includes="**/*.java,**/package.html"/>
+ <xsl:for-each select="project[contains(@name,'cocoon-block-')]">
+ <srcfiles
dir="{string('${blocks}')}/{substring-after(@name,'cocoon-block-')}/java"
includes="**/*.java,**/package.html"/>
+ </xsl:for-each>
+ </uptodate>
+ <istrue value="{string('${unless.exclude.javadocs}')}"/>
+ </or>
+ </condition>
+ </target>
+
+ <!-- Creates Javadocs -->
+ <target name="javadocs"
+ unless="javadocs.notrequired">
+ <xsl:attribute name="depends">init, javadocs-check<xsl:for-each
select="project[contains(@name,'cocoon-block-')]"><xsl:text>,</xsl:text><xsl:value-of
select="substring-after(@name,'cocoon-block-')"/>-prepare</xsl:for-each></xsl:attribute>
+
+ <condition property="javadoc.additionalparam" value="-breakiterator -tag
todo:all:Todo:">
+ <equals arg1="1.4" arg2="{string('${ant.java.version}')}"/>
+ </condition>
+ <condition property="javadoc.additionalparam" value="">
+ <not><equals arg1="1.4" arg2="{string('${ant.java.version}')}"/></not>
+ </condition>
+
+ <javadoc destdir="{string('${build.javadocs}')}"
+ author="true"
+ version="true"
+ use="true"
+ noindex="false"
+ splitindex="true"
+ windowtitle="{string('${Name}')} API {string('${version}')}
[{string('${TODAY}')}]"
+ doctitle="{string('${Name}')} API {string('${version}')}"
+ bottom="Copyright © {string('${year}')} Apache Software
Foundation. All Rights Reserved."
+ stylesheetfile="{string('${resources.javadoc}')}/javadoc.css"
+ useexternalfile="yes"
+ additionalparam="{string('${javadoc.additionalparam}')}"
+ maxmemory="128m">
+
+ <link offline="true" href="http://avalon.apache.org/api";
packagelistloc="${resources.javadoc}/avalon"/>
+ <link offline="true" href="http://xml.apache.org/xerces2-j/javadocs/api";
packagelistloc="${resources.javadoc}/xerces"/>
+ <link offline="true" href="http://xml.apache.org/xalan-j/apidocs";
packagelistloc="${resources.javadoc}/xalan"/>
+ <link offline="true" href="http://java.sun.com/j2se/1.4.1/docs/api";
packagelistloc="${resources.javadoc}/j2se"/>
+ <link offline="true"
href="http://java.sun.com/j2ee/sdk_1.3/techdocs/api";
packagelistloc="${resources.javadoc}/j2ee"/>
+
+ <packageset dir="{string('${java}')}">
+ <include name="**"/>
+ </packageset>
+ <packageset dir="{string('${deprecated.src}')}">
+ <include name="**"/>
+ </packageset>
+ <xsl:for-each select="project[contains(@name,'cocoon-block-')]">
+ <packageset
dir="{string('${blocks}')}/{substring-after(@name,'cocoon-block-')}/java">
+ <include name="**"/>
+ </packageset>
+ </xsl:for-each>
+ <classpath refid="classpath"/>
+ <xsl:for-each select="project[contains(@name,'cocoon-block-')]">
+ <classpath refid="{substring-after(@name,'cocoon-block-')}.classpath"/>
+ </xsl:for-each>
+ </javadoc>
+ </target>
+
<xsl:apply-templates select="project[contains(@name,'-block')]" />
<target name="patch-roles" depends="init">
@@ -282,57 +349,6 @@
<classpath refid="{$block-name}.classpath" />
<include name="**/samples/**/*.java"/>
</javac>
- </target>
-
- <!-- Check if javadocs have to be generated -->
- <target name="{$block-name}-javadoc-check">
- <mkdir dir="{string('${build.javadocs}')}"/>
- <condition property="{$block-name}.javadocs.notrequired" value="true">
- <or>
- <uptodate targetfile="{string('${build.javadocs}')}/packages.html" >
- <srcfiles dir= "{string('${blocks}')}/{$block-name}/java"
includes="**/*.java,**/package.html"/>
- </uptodate>
- <istrue value="{string('${unless.exclude.javadocs}')}"/>
- </or>
- </condition>
- </target>
-
- <target name="{$block-name}-javadoc"
- depends="{$block-name}-prepare, {$block-name}-javadoc-check"
- unless="{$block-name}.javadocs.notrequired" description="Builds the
API documentation for {$block-name} (javadocs)">
-
- <condition property="javadoc.additionalparam" value="-breakiterator -tag
todo:all:Todo:">
- <equals arg1="1.4" arg2="${ant.java.version}"/>
- </condition>
- <condition property="javadoc.additionalparam" value="">
- <not><equals arg1="1.4" arg2="{string('${ant.java.version}')}"/></not>
- </condition>
-
- <javadoc destdir="{string('${build.javadocs}')}"
- author="true"
- version="true"
- use="true"
- noindex="false"
- splitindex="true"
- windowtitle="{string('${Name}')} API
{string('${version}')} [{string('${TODAY}')}]"
- doctitle="{string('${Name}')} API {string('${version}')}"
- bottom="Copyright © {string('${year}')} Apache
Software Foundation. All Rights Reserved."
-
stylesheetfile="{string('${resources.javadocs}')}/javadoc.css"
- useexternalfile="yes"
- additionalparam="{string('${javadoc.additionalparam}')}">
-
- <link offline="true" href="http://avalon.apache.org/api";
packagelistloc="${resources.javadoc}/avalon"/>
- <link offline="true"
href="http://xml.apache.org/xerces2-j/javadocs/api";
packagelistloc="${resources.javadoc}/xerces"/>
- <link offline="true"
href="http://xml.apache.org/xalan-j/apidocs";
packagelistloc="${resources.javadoc}/xalan"/>
- <link offline="true"
href="http://java.sun.com/j2se/1.4.1/docs/api";
packagelistloc="${resources.javadoc}/j2se"/>
- <link offline="true"
href="http://java.sun.com/j2ee/sdk_1.3/techdocs/api";
packagelistloc="${resources.javadoc}/j2ee"/>
-
- <packageset dir="{string('${blocks}')}/{$block-name}/java">
- <include name="**"/>
- </packageset>
- <classpath refid="{$block-name}.classpath"/>
- </javadoc>
-
</target>
<target name="{$block-name}-build" if="{$block-name}.has.build">
