Re: TC3.3 - building javadoc
Mailing-List: contact [EMAIL PROTECTED]; run by ezmlm list-help: mailto:[EMAIL PROTECTED] list-unsubscribe: mailto:[EMAIL PROTECTED] list-post: mailto:[EMAIL PROTECTED] Delivered-To: mailing list [EMAIL PROTECTED] From: Mel Martinez [EMAIL PROTECTED] Subject: TC3.3 - building javadoc To: [EMAIL PROTECTED] 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 Storage500 Eldorado Blvd. MS UBRM11-194 e-mail: [EMAIL PROTECTED] Broomfield, CO 80021 Pray for snow Phone: (303) 272-8547 x78547 (e-mail me with subject SEND PUBLIC KEY to get public key)
RE: 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? +1 for build.xml I use ant dist in my RPM
RE: TC3.3 - building javadoc
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:[EMAIL PROTECTED]] Enviado el: viernes 23 de marzo de 2001 18:44 Para: [EMAIL PROTECTED] 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/
RE: TC3.3 - building javadoc
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. 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. target for most of the major tomcat packages but not all. mel --- "Ignacio J. Ortega" [EMAIL PROTECTED] 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:[EMAIL PROTECTED]] Enviado el: viernes 23 de marzo de 2001 18:44 Para: [EMAIL PROTECTED] 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/
RE: TC3.3 - building javadoc
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. 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. target for most of the major tomcat packages but not all. mel --- "Ignacio J. Ortega" [EMAIL PROTECTED] 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:[EMAIL PROTECTED]] Enviado el: viernes 23 de marzo de 2001 18:44 Para: [EMAIL PROTECTED] 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/
