tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Mel Martinez <melaqu...@yahoo.com>
Subject RE: TC3.3 - building javadoc
Date Fri, 23 Mar 2001 21:48:02 GMT
In the change I propose to make (I've already done it
locally and it seems to work well) we'd have the
following sorts of targets:

<target name="dist"         
depends="dist.prepare,javadoc,dist.war">
<target name="dist.prepare"         
depends="main,webapps,tomcat-jars-new">
<target name="javadoc"         
depends="main,webapps,tomcat-jars-new">
<target name="javadoc.tomcat"         
depends="main,webapps,tomcat-jars-new">
<target name="javadoc.tomcat.core"         
depends="main,webapps,tomcat-jars-new">
<target name="javadoc.tomcat.modules"         
depends="main,webapps,tomcat-jars-new">
<target name="javadoc.tomcat.util"         
depends="main,webapps,tomcat-jars-new">
<target name="javadoc.jasper"         
depends="main,webapps,tomcat-jars-new">
 ... etc...
<target name="dist.war" 
         depends="dist.prepare" >
<target name="dist.nojavadoc" 
         depends="dist.war">

Thus, the changed behavior would be that when you
build 'dist' you would get ALL the javadocs generated.
 If you want to build 'dist' with no javadocs, just
use

> build dist.war  or
> build dist.nojavadoc

If you want to build just a subset of the javadoc
(with or without any other targets), just specify the
particular javadoc.xxxx target in your list of
targets.

> build dist.war javadoc.tomcat.core

At this point, the javadoc targets are somewhat
exclusive - generating one wipes the index.html of the
previous build, although the actual doc pages are not
wiped.  There are ways to address this, but not worth
the effort right now.

Is this cool with folks?  Note - I'll try to add a
separate javadoc.xxxx target for most of the major
tomcat packages but not all.

mel

--- "Ignacio J. Ortega" <nacho@siapi.es> wrote:
> Normally i use a custom build that generates
> org.apache.tomcat.*
> javadocs instead of the normal reduced set..
> 
> I'm +1 on this change for release..
> 
> 
> 
> Saludos ,
> Ignacio J. Ortega
> 
> 
> > -----Mensaje original-----
> > De: Mel Martinez [mailto:melaquias@yahoo.com]
> > Enviado el: viernes 23 de marzo de 2001 18:44
> > Para: tomcat-dev@jakarta.apache.org
> > Asunto: TC3.3 - building javadoc
> > 
> > 
> > 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?
> > 
> > Mel
> > 
> > 
> > __________________________________________________
> > Do You Yahoo!?
> > Get email at your own domain with Yahoo! Mail. 
> > http://personal.mail.yahoo.com/
> > 


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

Mime
View raw message