svn commit: rev 37267 - in incubator/beehive/trunk/netui: ant docs docs/tools/lib

[st...@apache.org]

Author: steveh
Date: Tue Aug 31 15:52:51 2004
New Revision: 37267

Modified:
   incubator/beehive/trunk/netui/ant/javadoc.xml
   incubator/beehive/trunk/netui/docs/BUILDING_NETUI_DOCS.txt
   incubator/beehive/trunk/netui/docs/tools/lib/jsptagrefdoclet.jar
Log:
Fixed link-related bug in (jar-imbedded) XSLT files.

Modified: incubator/beehive/trunk/netui/ant/javadoc.xml
==============================================================================
--- incubator/beehive/trunk/netui/ant/javadoc.xml	(original)
+++ incubator/beehive/trunk/netui/ant/javadoc.xml	Tue Aug 31 15:52:51 2004
@@ -32,9 +32,9 @@
       <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-conceptual-doc - Copies the conceptual docs to the build directory."/>
       <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="|                                                                              |"/> 
@@ -42,31 +42,31 @@
     </target>
   
     <!-- You must deploy netui before you run this target, or any of its sub-targets. -->
-    <target name="build" description="Generate Javadoc for all core server and tags">
+    <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-conceptual-doc"/>
       <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="generate-conceptual-doc">
+    <target name="copy-to-build-dir">
       <copy todir="${docs.build.dir}" overwrite="true">
         <fileset dir="${docs.dir}/guide"/>
       </copy>
-    </target>
-
+    </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.build.dir}/reference/java-class"
+      <javadoc destdir="${docs.dir}/guide/reference/java-class"
                maxmemory="256M"
                windowtitle="Page Flow API Documentation"
                doctitle="Page Flow API Documentation"
@@ -96,7 +96,7 @@
         <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}/bootstrap"/>
         <packageset dir="${src.dir}/compiler"/>
         <packageset dir="${src.dir}/pageflow"/>
         <packageset dir="${src.dir}/scoping"/>
@@ -105,24 +105,25 @@
         <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}/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.">
 		<delete dir="${docs.temp}" failonerror="false"/>
-		<delete dir="${docs.build.dir}/reference/taglib" failonerror="false"/>
+		<delete dir="${docs.dir}/guide/reference/taglib" failonerror="false"/>
 		<mkdir dir="${docs.temp}/tld"/>
 		<mkdir dir="${docs.temp}/xml/tagref"/>
 		<mkdir dir="${docs.temp}/html/tagref"/>
-		<mkdir dir="${docs.build.dir}/reference/taglib"/>
+		<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.build.dir}/reference/taglib"/>
+				<param name="-htmldir" value="${docs.dir}/guide/reference/taglib"/>
 				<param name="-breakiterator"/>
 			</doclet>
 			<!-- <link href="http://feverhouse.com" offline="true" packagelistLoc="../build/docs/java-class"/> -->
@@ -168,6 +169,12 @@
       <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>
 
 </project>

Modified: incubator/beehive/trunk/netui/docs/BUILDING_NETUI_DOCS.txt
==============================================================================
--- incubator/beehive/trunk/netui/docs/BUILDING_NETUI_DOCS.txt	(original)
+++ incubator/beehive/trunk/netui/docs/BUILDING_NETUI_DOCS.txt	Tue Aug 31 15:52:51 2004
@@ -28,4 +28,8 @@
 run ant -f javadoc.xml build
 
 The completed documentation can be found at BEEHIVE_HOME/netui/build/docs.
+    The home page for all docs is located at BEEHIVE_HOME/netui/build/docs/index.html.
+    The Conceptual docs are located at BEEHIVE_HOME/netui/build/docs/guide
+    The Netui API Reference is located at BEEHIVE_HOME/netui/build/docs/reference/java-class/index.html
+    The Netui Tag Library is located at BEEHIVE_HOME/netui/build/docs/reference/taglib/index.html
  

Modified: incubator/beehive/trunk/netui/docs/tools/lib/jsptagrefdoclet.jar
==============================================================================
Binary files. No diff available.