Skip to content

Commit

Permalink
Now the javadocs contains all sources from all blocks
Browse files Browse the repository at this point in the history 
git-svn-id: https://svn.apache.org/repos/asf/cocoon/trunk@24886 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
@cziegeler
cziegeler committed Jul 2, 2003
1 parent 4cf4299 commit 2071630
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 56 deletions.
15 changes: 10 additions & 5 deletions src/targets/docs-build.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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}"/>

Expand Down Expand Up @@ -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">
Expand All @@ -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:">
Expand Down Expand Up @@ -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"
Expand Down
118 changes: 67 additions & 51 deletions tools/src/blocks-build.xsl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 &#169; {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">
Expand Down Expand Up @@ -284,57 +351,6 @@
</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 &#169; {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">
<ant inheritAll="true"
inheritRefs="false"
Expand Down

0 comments on commit 2071630

Please sign in to comment.