https://issues.apache.org/bugzilla/show_bug.cgi?id=47700
Summary: Javadocs (html doc for Java files) should be part of
the build.xml
Product: Tomcat 6
Version: 6.0.20
Platform: PC
OS/Version: Windows XP
Status: NEW
Severity: minor
Priority: P2
Component: Documentation
AssignedTo: [email protected]
ReportedBy: [email protected]
--- Comment #0 from Martin Gainty <[email protected]> 2009-08-17 06:52:40 PDT
---
add these properties to properties,classpath and target for
apache-tomcat-6.0.20-src build.xml
<property name="commons-logging.jar"
value="C:/commons-logging/commons-logging-1.0.4/commons-logging.jar"/>
<property name="tools-ant.jar"
value="C:/ANT/apache-ant-1.7.1/lib/ant_jar/org/apache/tools/ant/ant.jar"/>
<property name="log4j.jar"
value="C:/Log4J/apache-log4j-1.2.15/log4j-1.2.15.jar"/>
<property name="eclipse.jar" value="C:/Eclipse/eclipse/plugins"/>
<property name="jaxrpc.jar" value="C:/JAXRPC/jaxrpc.jar"/>
<property name="wsdl4j.jar"
value="C:/AXIS/axis2-1.5/stagingRepo/axis2-1.5/lib/wsdl4j-1.6.2.jar"/>
<property name="puretls.jar"
value="C:/TOMCAT/apache-tomcat-6.0.14-src/output/build/puretls.jar"/>
<!-- Classpath -->
<path id="tomcat.classpath">
<pathelement location="${puretls.jar}"/>
<pathelement location="${ant.jar}"/>
<pathelement location="${jdt.jar}"/>
<pathelement location="${log4j.jar}"/>
<pathelement location="${tools-ant.jar}"/>
<pathelement location="${commons-logging.jar}"/>
<pathelement location="${eclipse.jar}"/>
<pathelement location="${jaxrpc.jar}"/>
<pathelement location="${wsdl4j.jar}"/>
</path>
<!-- MCG new target for Javadoc-->
<target name="javadoc" depends="compile">
<javadoc
destdir="webapps/docs/api"
author="true"
version="true"
use="true"
windowtitle="TOMCAT API"
sourcepath="java"
classpathref="tomcat.classpath">
<packageset dir="java" defaultexcludes="no">
<include name="javax/annotation/**"/>
<include name="javax/ejb/**"/>
<include name="javax/el/**"/>
<include name="javax/mail/**"/>
<include name="javax/persistence/**"/>
<include name="javax/servlet/**"/>
<include name="javax/xml/**"/>
<include name="org/apache/**"/>
</packageset>
<doctitle><![CDATA[<h1>TitleGoesHere</h1>]]></doctitle>
<bottom><![CDATA[<i>Copyright © 2009 Tomcat cats. All Rights
Reserved.</i>]]></bottom>
<tag name="todo" scope="all" description="To do:"/>
<group title="Annotation Packages" packages="javax.annotation.*"/>
<group title="EJB Packages" packages="javax.ejb.*"/>
<group title="Base EL Packages" packages="javax.el.*"/>
<group title="Mail Packages" packages="javax.mail.*"/>
<group title="Persistence Packages" packages="javax.persistence.*"/>
<group title="Servlet Packages" packages="javax.servlet.*"/>
<group title="Catalina Packages" packages="org.apache.catalina.*"/>
<group title="Coyote Packages" packages="org.apache.coyote.*"/>
<group title="Apache EL Packages" packages="org.apache.el.*" />
<group title="Apache Jasper packages" packages="org.apache.jasper.*"/>
<group title="Apache JK packages" packages="org.apache.jk.*"/>
<group title="Apache Juli packages" packages="org.apache.juli.*"/>
<group title="Apache naming packages" packages="org.apache.naming.*" />
<group title="Apache tomcat core packages" packages="org.apache.tomcat.*"
/>
<link offline="true" href="http://java.sun.com/j2se/1.5.0/docs/api/";
packagelistLoc="C:\tmp"/>
<link
href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
</javadoc>
</target>
produces nice indexed html formatted javadocs for all aforementioned packages
source is from java folder and outputs html to webapps/docs/api
java -version
Runtime_Environment (build 1.6.0_12-b04)
ant -version
1.7.1 compiled on June 27 2008
tested on apache-tomcat-6.0.20-src
(as per suggestion of Konstatin Kolinko)
if interested i have a zipped webapps/docs/docs.zip displaying indexed javadocs
thanks,
--
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
