tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Arieh Markel <Arieh.Mar...@Sun.COM>
Subject Re: TC3.3 - building javadoc
Date Mon, 26 Mar 2001 15:20:01 GMT

> Mailing-List: contact tomcat-dev-help@jakarta.apache.org; run by ezmlm
> list-help: <mailto:tomcat-dev-help@jakarta.apache.org>
> list-unsubscribe: <mailto:tomcat-dev-unsubscribe@jakarta.apache.org>
> list-post: <mailto:tomcat-dev@jakarta.apache.org>
> Delivered-To: mailing list tomcat-dev@jakarta.apache.org
> From: Mel Martinez <melaquias@yahoo.com>
> Subject: TC3.3 - building javadoc
> To: tomcat-dev@jakarta.apache.org
> X-Spam-Rating: h31.sny.collab.net 1.6.2 0/1000/N
> 
> Currently, when you run the build script (for TC 3.3),
> build.xml has 'dist' dependent on the 'javadoc'
> target.  The 'javadoc' target compiles javadoc pages
> for org.apache.tomcat.core and
> org.apache.tomcat.modules.*.
> 
> I dunno about you, but this seems insufficient for
> 'dist'.  Shouldn't the javadoc set for distribution
> include all or most of the packages?  
> 
> Also, it would probably be useful for dev
> documentation purposes to have some secondary javadoc
> targets like javadoc.tomcat.core',
> 'javadoc.tomcat.util', 'javadoc.tomcat.modules',
> 'javadoc.jasper', etc.  That way when you work on the
> javadocs for a package you can rapidly compile just
> that section.  This MIGHT encourage better documenting
> of code than is currently happening... :-)
> 
> Anybody else think this is a good (or bad) idea?

I think this is a good idea.

Here is a snipped of a modified generatedocs.sh script that I built to
create the javadocs (it is not updated but a snapshot of 3.3 at the time):

javadoc -verbose -sourcepath src/share -d 
/ws/sx1.0-tools/jakarta/v3.2-4/dist/jakarta-tomcat/doc/api -use -version -author 
-windowtitle "Jakarta/Java Servlet API Reference, v2.2" -doctitle "Jakarta/Java 
Servlet API Reference, v2.2" \
javax.servlet \
javax.servlet.http \
javax.servlet.jsp \
javax.servlet.jsp.tagext \
org.apache.jasper \
org.apache.jasper.compiler \
org.apache.jasper.runtime \
org.apache.jasper.servlet \
org.apache.tomcat.context \
org.apache.tomcat.core \
org.apache.tomcat.helper \
org.apache.tomcat.logging \
org.apache.tomcat.modules.server \
org.apache.tomcat.request \
org.apache.tomcat.service \
org.apache.tomcat.service.connector \
org.apache.tomcat.service.http \
org.apache.tomcat.session \
org.apache.tomcat.startup \
org.apache.tomcat.task \
org.apache.tomcat.util \
org.apache.tomcat.util.depend \
org.apache.tomcat.util.net \
org.apache.tomcat.util.pattern \
org.apache.tomcat.util.threads \
org.apache.tomcat.util.xml 

(the package list need to be updated).

Arieh
> 
> Mel
> 
> 
> __________________________________________________
> Do You Yahoo!?
> Get email at your own domain with Yahoo! Mail. 
> http://personal.mail.yahoo.com/

--
 Arieh Markel		                Sun Microsystems Inc.
 Network Storage                        500 Eldorado Blvd. MS UBRM11-194
 e-mail: arieh.markel@sun.COM           Broomfield, CO 80021
 Pray for snow !!!!                     Phone: (303) 272-8547 x78547
 (e-mail me with subject SEND PUBLIC KEY to get public key)


Mime
View raw message