You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by st...@apache.org on 2004/07/20 20:35:07 UTC

svn commit: rev 23087 - incubator/beehive/trunk/netui/ant

Author: steveh
Date: Tue Jul 20 11:35:07 2004
New Revision: 23087

Added:
   incubator/beehive/trunk/netui/ant/javadoc.xml   (contents, props changed)
Log:
Contains targets for building API reference and tag library reference.

Added: incubator/beehive/trunk/netui/ant/javadoc.xml
==============================================================================
--- (empty file)
+++ incubator/beehive/trunk/netui/ant/javadoc.xml	Tue Jul 20 11:35:07 2004
@@ -0,0 +1,225 @@
+<?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.temp" value="${docs.dir}/temp"/>	
+
+    <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/server/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="${tools.jar}"/>
+      <pathelement path="${ant.jar}"/>
+    </path>
+
+    <!-- You must deploy netui before you run this target, or any of its sub-targets. -->
+    <target name="redeploy_all" description="Generate Javadoc for all core server and tags">
+      <antcall target="clean-class-ref"/>
+      <antcall target="clean-taglib-ref"/>
+      <antcall target="generate-class-ref"/>
+      <antcall target="generate-taglib-ref"/>
+    </target>	
+
+    <target name="generate-all-ref" description="Generate Javadoc for all core server and tags">
+      <antcall target="generate-class-ref"/>
+      <antcall target="generate-taglib-ref"/>
+    </target>	
+
+    <target name="clean-all-ref">
+      <antcall target="clean-class-ref"/>
+      <antcall target="clean-taglib-ref"/>
+    </target>
+    
+    <target name="generate-taglib-ref">
+      <antcall target="generate-taglib-ref-xml"/>
+      <antcall target="generate-taglib-ref-html"/>
+    </target>
+
+    <target name="generate-class-ref">
+      <javadoc destdir="${docs.dir}/dist/classref"
+               maxmemory="256M"
+               windowtitle="Page Flow API Documentation"
+               doctitle="Page Flow API Documentation"
+               version="true"
+               author="false"
+               use="true"
+               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=""/>
+        <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=""/>
+        <packageset dir="${src.dir}/bootstrap" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/**/*" />
+        </packageset>
+        <packageset dir="${src.dir}/compiler" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/**/*" />
+        </packageset>
+        <packageset dir="${src.dir}/pageflow" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/pageflow/config/**/*" />
+          <include name="org/apache/beehive/netui/pageflow/handler/**/*" />
+          <include name="org/apache/beehive/netui/pageflow/interceptor/**/*" />
+          <include name="org/apache/beehive/netui/pageflow/internal/**/*" />
+          <include name="org/apache/beehive/netui/pageflow/util/**/*" />
+          <include name="org/apache/beehive/netui/pageflow/internal/**/*" />
+          <include name="org/apache/beehive/netui/script/**/*" />
+        </packageset>
+        <packageset dir="${src.dir}/scoping" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/**/*" />
+        </packageset>
+        <packageset dir="${src.dir}/tags-databinding" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/databinding/**/*" />
+          <include name="org/apache/beehive/netui/tags/**/*" />
+        </packageset>
+        <packageset dir="${src.dir}/tags-datagrid" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/datagrid/**/*" />
+          <include name="org/apache/beehive/netui/tags/**/*" />
+        </packageset>
+        <packageset dir="${src.dir}/tags-html" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/tags/**/*" />
+        </packageset>
+        <packageset dir="${src.dir}/tags-template" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/tags/**/*" />
+        </packageset>
+        <packageset dir="${src.dir}/util" defaultexcludes="yes">
+          <include name="org/apache/beehive/netui/util/**/*" />
+        </packageset>
+      </javadoc>
+    </target>
+
+    <target name="clean-class-ref">
+	  <!--echo message="Deleting ${docs.dir}/dist"/-->
+      <delete dir="${docs.dir}/dist/classref"/>
+    </target>
+
+    <target name="generate-taglib-ref-xml" description="Uses a custom doclet to generate XML from Java source files.">
+    <antcall target="copy-tld-files"/>
+    <antcall target="insert-namespace-for-tld"/>
+    <delete dir="${docs.temp}/xml/tagref" failonerror="false"/>
+    <mkdir dir="${docs.temp}/xml/tagref"/>
+    <javadoc classpathref="javadoc.classpath"
+             destdir="${docs.temp}/xml/tagref">
+      <doclet name="org.apache.beehive.netui.tools.doclet.jsptagref.JspTagRef"
+              path="${docs.dir}/tools/lib/jsptagrefdoclet.jar;${docs.dir}/tools/lib/jsptagrefschema.jar;${docs.dir}/tools/lib/xbean.jar;${xbean.jar};tools/lib/helputil.jar">
+        <param name="-source" value="1.5"/>
+        <param name="-tlddir" value="${docs.temp}/tld"/>
+        <param name="-breakiterator"/>
+      </doclet> 
+      <packageset dir="${src.dir}/tags-databinding">
+        <include name="org/apache/beehive/netui/tags/databinding/bundle"/>
+        <include name="org/apache/beehive/netui/tags/databinding/cellrepeater"/>
+        <include name="org/apache/beehive/netui/tags/databinding/invoke"/>
+        <include name="org/apache/beehive/netui/tags/databinding/message"/>
+        <include name="org/apache/beehive/netui/tags/databinding/pageinput"/>		
+        <include name="org/apache/beehive/netui/tags/databinding/repeater"/>
+        <include name="org/apache/beehive/netui/tags/databinding/repeater/choice"/>
+        <include name="org/apache/beehive/netui/tags/databinding/repeater/pad"/>
+        <include name="org/apache/beehive/netui/tags/databinding/script"/>
+      </packageset>
+      <packageset dir="${src.dir}/tags-datagrid">      
+        <include name="org/apache/beehive/netui/tags/datagrid"/>      
+        <include name="org/apache/beehive/netui/datagrid/model"/>
+      </packageset>
+      <packageset dir="${src.dir}/tags-html">
+        <include name="org/apache/beehive/netui/tags/html"/>
+        <include name="org/apache/beehive/netui/tags/tree"/>
+      </packageset>
+      <packageset dir="${src.dir}/tags-template">
+        <include name="org/apache/beehive/netui/tags/template"/>
+      </packageset>	 	  
+    </javadoc> 
+  </target>
+  
+  <target name="generate-taglib-ref-html" description="Transform the XML into HTML.">
+    <!-- Cleans and recreates the dest dir -->
+    <delete dir="${docs.dir}/dist/taglib" failonerror="false"/>
+    <mkdir dir="${docs.dir}/dist/taglib"/>
+    <!-- Move the static files into place -->
+    <copy todir="${docs.dir}/dist/taglib">
+      <fileset dir="${docs.dir}/tools/static_files">
+      </fileset>
+    </copy>
+    <!-- Generates the tag ref TOC nav page -->
+    <!--xslt in="doclets/doclets/temp/xml/tagref/summary.xml"
+          out="doclets/doclets/temp/html/toc.html"
+          style="doclets/doclets/xslt/tag_ref_toc.xslt"
+      <param name="localRelativePath" expression="../../../"/>
+    </xslt-->    
+    <!-- Generates the overview-summary page -->
+    <!--xslt in="doclets/doclets/temp/xml/tagref/summary.xml"
+          out="doclets/doclets/temp/html/overview-summary.html"
+          style="doclets/doclets/xslt/tag_ref_summary.xslt">
+      <param name="localRelativePath" expression="../../../"/>
+    </xslt--> 
+    <xslt basedir="${docs.temp}/xml/tagref"
+          destdir="${docs.dir}/dist/taglib"
+          style="${docs.dir}/tools/xslt/tag_ref_classic.xslt"
+          includes="**/*.xml">
+      <param name="localRelativePath" expression="../../../"/>
+    </xslt>
+  </target>
+
+  <!-- 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="Extract TLD files from their zip container.">
+    <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>
+
+  <!-- Add a namespace declaration to the TLD files so that they can be loaded into XMLBeans. Having the
+       TLDs in the same namespace as other Javadoc XML makes life much easier when merging values from the
+       two sources. -->
+  <target name="insert-namespace-for-tld" description="Inserts the namespace attribute needed by format.tag.ref">
+    <replace dir="${docs.temp}/tld" value="&lt;taglib xmlns='http://apache.org/beehive/netui/tools/doclet/schema'">
+      <include name="**/*.tld"/>
+      <replacetoken><![CDATA[<taglib]]></replacetoken>
+    </replace>
+  </target>
+  
+  <target name="clean-taglib-ref">
+    <!--echo message="Deleting ${docs.dir}/dist"/-->
+    <delete dir="${docs.dir}/dist/taglib"/>
+  </target>
+
+  <target name="usage">
+    <java fork="no" classname="org.apache.tools.ant.Main">
+      <arg line="-projecthelp"/>
+    </java>
+  </target>
+
+</project>