cmlenz 2003/03/18 02:13:57
Modified: documentation/docs/xdocs javadoc.xml sitemap.xml
documentation build.xml
documentation/docs/xdocs/integration/ant navigation.xml
Log:
Integrate the Ant-integration Javadocs with the documentation:
- Copy the Javadocs to the documentation target directory (always uses
the "dist-13" directory, because the documentation doesn't differ
between the J2EE versions; yeah, it's ugly)
- Provide a link in the sub-navigation of the Ant-integration docs
Also, removed the "Anttasks" Javadoc link from the main Javadocs
page. As the Anttasks module now only provides tasks that are used
for building Cactus itself, the API documentation doesn't need to be
visible and could potentially confuse users.
Revision Changes Path
1.8 +0 -6 jakarta-cactus/documentation/docs/xdocs/javadoc.xml
Index: javadoc.xml
===================================================================
RCS file: /home/cvs/jakarta-cactus/documentation/docs/xdocs/javadoc.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- javadoc.xml 28 Jan 2003 15:48:19 -0000 1.7
+++ javadoc.xml 18 Mar 2003 10:13:57 -0000 1.8
@@ -25,12 +25,6 @@
</tr>
<tr>
<td>
- <link href="site:javadoc_anttasks">Javadoc for Cactus custom Ant
- tasks</link>
- </td>
- </tr>
- <tr>
- <td>
<link href="site:javadoc_framework_12">Javadoc for Cactus for
J2EE 1.2</link>
</td>
1.21 +1 -1 jakarta-cactus/documentation/docs/xdocs/sitemap.xml
Index: sitemap.xml
===================================================================
RCS file: /home/cvs/jakarta-cactus/documentation/docs/xdocs/sitemap.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- sitemap.xml 17 Mar 2003 23:05:44 -0000 1.20
+++ sitemap.xml 18 Mar 2003 10:13:57 -0000 1.21
@@ -90,7 +90,7 @@
<resource id="code_test_sample_servlet" target="misc/TestSampleServlet.class"/>
<resource id="code_junit_noframes" target="misc/junit-noframes.xsl"/>
- <resource id="javadoc_anttasks" check="false" target="api/anttasks/index.html"/>
+ <resource id="javadoc_integration_ant" check="false"
target="api/integration/ant/index.html"/>
<resource id="javadoc_framework_12" check="false"
target="api/framework-12/index.html"/>
<resource id="javadoc_framework_13" check="false"
target="api/framework-13/index.html"/>
<resource id="javadoc_framework_jsptaglifecycle" check="false"
target="api/framework-13/org/apache/cactus/extension/jsp/JspTagLifecycle.html"/>
1.37 +9 -8 jakarta-cactus/documentation/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-cactus/documentation/build.xml,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -r1.36 -r1.37
--- build.xml 24 Feb 2003 21:10:03 -0000 1.36
+++ build.xml 18 Mar 2003 10:13:57 -0000 1.37
@@ -60,10 +60,11 @@
<!-- Locations of javadocs that need to be included if javadoc.include
is defined -->
<property name="dist.framework.javadoc.12"
- value="framework/dist-12/doc/api"/>
+ location="framework/dist-12/doc/api"/>
<property name="dist.framework.javadoc.13"
- value="framework/dist-13/doc/api"/>
- <property name="dist.anttasks.javadoc" value="anttasks/dist/doc/api"/>
+ location="framework/dist-13/doc/api"/>
+ <property name="dist.integration.ant.javadoc"
+ location="integration/ant/dist-13/doc/api"/>
<!-- Set the properties related to the target area -->
<property name="target.classes.dir" value="${target.dir}/classes"/>
@@ -251,26 +252,26 @@
<and>
<available file="${dist.framework.javadoc.12}/index.html"/>
<available file="${dist.framework.javadoc.13}/index.html"/>
- <available file="${dist.anttasks.javadoc}/index.html"/>
+ <available file="${dist.integration.ant.javadoc}/index.html"/>
</and>
</condition>
<fail unless="javadoc.include.ok">One of the javadoc has not been
-generated. Run 'ant dist.javadoc -verbose' to know what the problem is.</fail>
+generated. Run 'ant dist.javadoc -verbose' to find out what the problem is.</fail>
</target>
<target name="dist.javadoc" depends="dist.javadoc.check"
if="javadoc.include.ok">
- <copy todir="${dist.doc.api.dir}/anttasks">
- <fileset dir="${dist.anttasks.javadoc}"/>
- </copy>
<copy todir="${dist.doc.api.dir}/framework-12">
<fileset dir="${dist.framework.javadoc.12}"/>
</copy>
<copy todir="${dist.doc.api.dir}/framework-13">
<fileset dir="${dist.framework.javadoc.13}"/>
+ </copy>
+ <copy todir="${dist.doc.api.dir}/integration/ant">
+ <fileset dir="${dist.integration.ant.javadoc}"/>
</copy>
</target>
1.4 +4 -0
jakarta-cactus/documentation/docs/xdocs/integration/ant/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/jakarta-cactus/documentation/docs/xdocs/integration/ant/navigation.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- navigation.xml 17 Mar 2003 23:05:44 -0000 1.3
+++ navigation.xml 18 Mar 2003 10:13:57 -0000 1.4
@@ -17,4 +17,8 @@
<item id="task_webxmlmerge" label="WebXmlMerge"/>
</menu>
+ <menu label="Development">
+ <item id="javadoc_integration_ant" label="API Documentation"/>
+ </menu>
+
</navigation>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
