Author: steveh
Date: Mon Oct 11 15:57:43 2004
New Revision: 54632
Modified:
incubator/beehive/trunk/netui/ant/javadoc.xml
Log:
Latest build file for netui docs.
Modified: incubator/beehive/trunk/netui/ant/javadoc.xml
==============================================================================
--- incubator/beehive/trunk/netui/ant/javadoc.xml (original)
+++ incubator/beehive/trunk/netui/ant/javadoc.xml Mon Oct 11 15:57:43 2004
@@ -1,134 +1,110 @@
<?xml version="1.0"?>
-
<project name="Beehive/NetUI/DevBuild" default="usage" basedir=".">
-
- <property environment="os"/>
- <property file="${os.BEEHIVE_HOME}/beehive.properties"/>
- <property file="bootstrap.properties"/>
- <property file="common.properties"/>
-
- <property name="docs.build.dir" value="${build.dir}/docs"/>
- <property name="docs.temp" value="${docs.build.dir}/temp"/>
- <property name="xalan-241.jar"
location="${docs.dir}/external/xalan-241.jar"/>
-
- <path id="javadoc.classpath">
- <fileset dir="${struts.dir}" includes="*.jar"/>
- <fileset dir="${tomcat.lib.dir}/4x" includes="*.jar"/>
- <fileset dir="${xdoclet.dir}" includes="*.jar"/>
- <fileset dir="${build.lib.dir}" includes="*.jar"/>
- <fileset dir="${log4j.dir}/dist/lib" includes="*.jar"/>
- <fileset dir="${beehive.installed.dir}/jakarta-tomcat-5.0.25/common/lib"
includes="*.jar"/>
- <pathelement path="${xbean.jar}"/>
- <pathelement path="${jsr173.jar}"/>
- <pathelement path="${controls.jar}"/>
- <pathelement path="${jsf-api.jar}"/>
- <pathelement path="${tools.jar}"/>
- <pathelement path="${ant.jar}"/>
- </path>
-
- <target name="usage">
- <echo
message="================================================================================"/>
- <echo message="| Usage
|"/>
- <echo
message="================================================================================"/>
- <echo message="build - Cleans and builds all doc, copies the result to
the forrest site. "/>
- <echo message="clean - Deletes the built netui docs and associated temp
files."/>
- <echo message="generate-class-ref - Generates the Page Flow class
reference, using the standard Javadoc doclet."/>
- <echo message="generate-taglib-ref - Generates the netui Tag Library
reference."/>
- <echo message="copy-to-build-dir - Copies the doc set (= conceptual docs
and reference docs) to the build directory"/>
- <echo message="copy-to-forrest - Copies the built netui docs to the
forrest site."/>
- <echo
message="================================================================================"/>
- <echo message="|
|"/>
- <echo
message="================================================================================"/>
- </target>
-
- <!-- You must deploy netui before you run this target, or any of its
sub-targets. -->
- <target name="build" description="Generates Javadoc for all core classes
and tags, copies all docs to the build directory for distribution.">
- <antcall target="clean"/>
- <antcall target="generate-class-ref"/>
- <antcall target="generate-taglib-ref"/>
- <antcall target="copy-to-build-dir"/>
- </target>
-
- <target name="clean">
- <delete dir="${docs.temp}" failonerror="false"/>
- <delete dir="${build.dir}/docs" failonerror="false"/>
- <delete dir="${docs.dir}/temp" failonerror="false"/>
- </target>
-
- <target name="copy-to-build-dir">
- <copy todir="${docs.build.dir}" overwrite="true">
- <fileset dir="${docs.dir}/guide"/>
- </copy>
- </target>
-
- <!-- The 'use' attribute is currently set to 'false' because of Java bug
5055723.
+ <property environment="os"/>
+ <property file="${os.BEEHIVE_HOME}/beehive.properties"/>
+ <property file="bootstrap.properties"/>
+ <property file="common.properties"/>
+ <property name="docs.build.dir" value="${build.dir}/docs"/>
+ <property name="docs.temp" value="${docs.build.dir}/temp"/>
+ <property name="xalan-241.jar"
location="${docs.dir}/external/xalan-241.jar"/>
+ <path id="javadoc.classpath">
+ <fileset dir="${struts.dir}" includes="*.jar"/>
+ <fileset dir="${tomcat.lib.dir}/4x" includes="*.jar"/>
+ <fileset dir="${xdoclet.dir}" includes="*.jar"/>
+ <fileset dir="${build.lib.dir}" includes="*.jar"/>
+ <fileset dir="${log4j.dir}/dist/lib" includes="*.jar"/>
+ <fileset
dir="${beehive.installed.dir}/jakarta-tomcat-5.0.25/common/lib"
includes="*.jar"/>
+ <pathelement path="${xbean.jar}"/>
+ <pathelement path="${jsr173.jar}"/>
+ <pathelement path="${controls.jar}"/>
+ <pathelement path="${jsf-api.jar}"/>
+ <pathelement path="${tools.jar}"/>
+ <pathelement path="${ant.jar}"/>
+ </path>
+ <target name="usage">
+ <echo
message="================================================================================"/>
+ <echo message="| Usage
|"/>
+ <echo
message="================================================================================"/>
+ <echo message="build-docs - Cleans and builds all doc, copies
the result to the forrest site. "/>
+ <echo message="clean - Deletes the built netui docs and
associated temp files."/>
+ <echo message="generate-class-ref - Generates the Page Flow
class reference, using the standard Javadoc doclet."/>
+ <echo message="generate-taglib-ref - Generates the netui Tag
Library reference."/>
+ <echo message="copy-to-forrest - Copies the built netui docs to
the forrest site."/>
+ <echo
message="================================================================================"/>
+ <echo message="|
|"/>
+ <echo
message="================================================================================"/>
+ </target>
+ <!-- You must deploy netui before you run this target, or any of its
sub-targets. -->
+ <target name="build" description="Generates Javadoc for all core
classes and tags, copies all docs to the build directory for distribution, also
copies all docs to the forrest directory.">
+ <antcall target="clean"/>
+ <antcall target="generate-class-ref"/>
+ <antcall target="generate-taglib-ref"/>
+ <fixcrlf srcdir="${docs.dir}"/>
+ <!--<antcall target="copy-to-forrest"/>-->
+ </target>
+ <target name="clean">
+ <delete dir="${docs.temp}" failonerror="false"/>
+ <delete dir="${build.dir}/docs" failonerror="false"/>
+ <delete dir="${docs.dir}/temp" failonerror="false"/>
+ </target>
+ <!-- The 'use' attribute is currently set to 'false' because of Java
bug 5055723.
This bug will be fixed for the general release of JDK5.
Track the bug at:
http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5055723
When the fix arrives in JDK5, set use="true". -->
- <target name="generate-class-ref">
- <javadoc destdir="${docs.dir}/guide/reference/java-class"
- maxmemory="256M"
- windowtitle="Page Flow API Documentation"
- doctitle="Page Flow API Documentation"
- version="true"
- author="false"
- use="false"
- additionalparam="-breakiterator -noqualifier all"
- useexternalfile="true"
- classpathref="javadoc.classpath"
- source="1.5">
- <tag name="example" description="Example"/>
- <tag name="xdoclet.taghandler" enabled="false" description=""/>
- <tag name="doc\:tag" enabled="false" description=""/>
- <tag name="doc.tag" enabled="false" description=""/>
- <tag name="doc\:param" enabled="false" description=""/>
- <tag name="doc.param" enabled="false" description=""/>
- <tag name="created" enabled="false" description=""/>
- <tag name="ant.element" enabled="false" description=""/>
- <tag name="netui\:tag" enabled="false" description=""/>
- <tag name="netui.tldx\:tag" enabled="false" description=""/>
- <tag name="netui\:attribute" enabled="false" description=""/>
- <tag name="netui.tldx\:attribute" enabled="false" description=""/>
- <tag name="todo" enabled="false" description=""/>
- <tag name="todo\:" enabled="false" description=""/>
- <tag name="exclude" enabled="false" description=""/>
- <tag name="jsptagref.tagdescription" enabled="false" description=""/>
- <tag name="jsptagref.attributedescription" enabled="false"
description=""/>
- <tag name="jsptagref.databindable" enabled="false" description=""/>
- <tag name="jsptagref.attributesyntaxvalue" enabled="false"
description=""/>
- <packageset dir="${src.dir}/bootstrap"/>
- <packageset dir="${src.dir}/compiler"/>
- <packageset dir="${src.dir}/pageflow"/>
- <packageset dir="${src.dir}/scoping"/>
- <packageset dir="${src.dir}/tags-databinding"/>
- <packageset dir="${src.dir}/tags-html"/>
- <packageset dir="${src.dir}/tags-template"/>
- <packageset dir="${src.dir}/tomcat-common/4x"/>
- <packageset dir="${src.dir}/tomcat-server/4x"/>
- <packageset dir="${src.dir}/tomcat-webapp/4x"/>
- <packageset dir="${src.dir}/util"/>
- </javadoc>
- </target>
-
- <target name="generate-taglib-ref" description="Uses a custom doclet to
generate XML from Java source files.">
+ <target name="generate-class-ref">
+ <javadoc
destdir="${build.dir}/docs/reference/classref_pageflows" maxmemory="256M"
windowtitle="Page Flow API Documentation" doctitle="Page Flow API
Documentation" version="true" author="false" use="false"
additionalparam="-breakiterator -noqualifier all -notimestamp"
useexternalfile="true" classpathref="javadoc.classpath" source="1.5">
+ <tag name="example" description="Example"/>
+ <tag name="xdoclet.taghandler" enabled="false"
description=""/>
+ <tag name="doc\:tag" enabled="false" description=""/>
+ <tag name="doc.tag" enabled="false" description=""/>
+ <tag name="doc\:param" enabled="false" description=""/>
+ <tag name="doc.param" enabled="false" description=""/>
+ <tag name="created" enabled="false" description=""/>
+ <tag name="ant.element" enabled="false" description=""/>
+ <tag name="netui\:tag" enabled="false" description=""/>
+ <tag name="netui.tldx\:tag" enabled="false"
description=""/>
+ <tag name="netui\:attribute" enabled="false"
description=""/>
+ <tag name="netui.tldx\:attribute" enabled="false"
description=""/>
+ <tag name="todo" enabled="false" description=""/>
+ <tag name="todo\:" enabled="false" description=""/>
+ <tag name="exclude" enabled="false" description=""/>
+ <tag name="jsptagref.tagdescription" enabled="false"
description=""/>
+ <tag name="jsptagref.attributedescription"
enabled="false" description=""/>
+ <tag name="jsptagref.databindable" enabled="false"
description=""/>
+ <tag name="jsptagref.attributesyntaxvalue"
enabled="false" description=""/>
+ <packageset dir="${src.dir}/bootstrap"/>
+ <packageset dir="${src.dir}/compiler"/>
+ <!-- PageFlowManagedObject.java is not being included
because it is not marked "public". -->
+ <packageset dir="${src.dir}/pageflow"/>
+ <packageset dir="${src.dir}/scoping"/>
+ <packageset dir="${src.dir}/tags-databinding"/>
+ <packageset dir="${src.dir}/tags-html"/>
+ <packageset dir="${src.dir}/tags-template"/>
+ <packageset dir="${src.dir}/tomcat-common/4x"/>
+ <packageset dir="${src.dir}/tomcat-server/4x"/>
+ <packageset dir="${src.dir}/tomcat-webapp/4x"/>
+ <packageset dir="${src.dir}/util"/>
+ </javadoc>
+ </target>
+ <target name="generate-taglib-ref" description="Uses a custom doclet to
generate HTML topics from Java source files.">
<delete dir="${docs.temp}" failonerror="false"/>
- <delete dir="${docs.dir}/guide/reference/taglib"
failonerror="false"/>
+ <delete dir="${build.dir}/docs/reference/taglib"
failonerror="false"/>
+ <mkdir dir="${build.dir}/docs/reference/taglib"/>
<mkdir dir="${docs.temp}/tld"/>
<mkdir dir="${docs.temp}/xml/tagref"/>
<mkdir dir="${docs.temp}/html/tagref"/>
- <mkdir dir="${docs.dir}/guide/reference/taglib"/>
<antcall target="copy-tld-files"/>
<javadoc classpathref="javadoc.classpath"
destdir="${docs.temp}/xml/tagref">
<doclet
name="org.apache.beehive.netui.tools.doclet.jsptagref.JspTagDoc"
path="${docs.dir}/tools/lib/jsptagrefdoclet.jar;${xbean.jar};${jsr173.jar};${docs.dir}/external/xalan-241.jar">
<param name="-source" value="1.5"/>
<param name="-tlddir" value="${docs.temp}/tld"/>
<param name="-xmldir"
value="${docs.temp}/xml/tagref"/>
- <param name="-htmldir"
value="${docs.dir}/guide/reference/taglib"/>
+ <param name="-htmldir"
value="${build.dir}/docs/reference/taglib"/>
<param name="-breakiterator"/>
</doclet>
<!-- <link href="http://feverhouse.com"; offline="true"
packagelistLoc="../build/docs/java-class"/> -->
- <link href="../java-class"/>
- <link href="http://java.sun.com/j2se/1.5/docs/api/"/>
+ <link href="../classref_pageflows"/>
+ <link href="http://java.sun.com/j2se/1.5/docs/api/"/>
<packageset dir="${src.dir}/tags-databinding">
<include
name="org/apache/beehive/netui/tags/databinding/bundle"/>
<include
name="org/apache/beehive/netui/tags/databinding/cellrepeater"/>
@@ -154,27 +130,21 @@
<delete
file="${docs.build.dir}/reference/taglib/taglib-summary-ignore.html"
failonerror="false"/>
<delete dir="${docs.temp}" failonerror="false"/>
</target>
-
- <!-- Get the latest TLD files and unzip them to a temp folder. From there,
they'll be grabbed by
+ <!-- Get the latest TLD files and unzip them to a temp folder. From
there, they'll be grabbed by
the JspTagRef doclet for generating tag topics. -->
- <target name="copy-tld-files" description="copies tld files to another
directory, the copies are modified by insert-namespace-for-tld">
- <delete dir="${docs.temp}/tld" failonerror="false"/>
- <mkdir dir="${docs.temp}/tld"/>
- <copy todir="${docs.temp}/tld" overwrite="true">
- <fileset dir="${build.lib.dir}" includes="**/*.tld"/>
- </copy>
- </target>
-
- <target name="copy-to-forrest" description="">
- <copy todir="${beehive.dir}/site/src/documentation/content/docs"
overwrite="true">
- <fileset dir="${docs.build.dir}"/>
- </copy>
- </target>
-
- <target name="make-doclet-jar" description="Utiltiy function that re-JARs
jsptagrefdoclet.jar">
- <jar jarfile="${docs.dir}/tools/lib/jsptagrefdoclet.jar"
- basedir="${docs.dir}/tools/docletsrc"
- />
- </target>
-
+ <target name="copy-tld-files" description="copies tld files to another
directory, the copies are modified by insert-namespace-for-tld">
+ <delete dir="${docs.temp}/tld" failonerror="false"/>
+ <mkdir dir="${docs.temp}/tld"/>
+ <copy todir="${docs.temp}/tld" overwrite="true">
+ <fileset dir="${build.lib.dir}" includes="**/*.tld"/>
+ </copy>
+ </target>
+ <target name="copy-to-forrest" description="">
+ <copy
todir="${beehive.dir}/site/src/documentation/content/reference"
overwrite="true">
+ <fileset dir="${docs.build.dir}/reference"/>
+ </copy>
+ </target>
+ <target name="make-doclet-jar" description="Utiltiy function that
re-JARs jsptagrefdoclet.jar. Use this target if you make changes to the XSLT
files, or other files, imbedded in jsptagrefdoclet.jar">
+ <jar jarfile="${docs.dir}/tools/lib/jsptagrefdoclet.jar"
basedir="${docs.dir}/tools/docletsrc"/>
+ </target>
</project>
