Patrick Chanezon wrote:
>
> Hi ant users and developers,
>
> I enhanced the javadoc task in order to make full use of some javadoc
> features as descibed in
> http://jakarta.apache.org/bugs/show_bug.cgi?id=64
>
> which means:
> * support for multiple link options
> * support for multiple group options
> * support for the @ argument
>
> - link and linkoffline: you can now list more than one -link option,
> using a ; separator in your link tag to separate the different lines
> that will be generated
> - group: same remark, you can now list more than one -group option,
> using a ; separator in your group tag. arguments are
> groupheading;packagepattern:packagepattern:..
> - group: the syntax is "-group groupheading
> packagepattern:packagepattern:.."
> - the COMMAND LINE ARGUMENT FILE syntax: javadoc -d apidocs @packages
> is now supported with the packagelist
> tag this is how these options can be used in a build.xml file:
>
> <javadoc sourcepath="${src.dir}"
> destdir="${build.javadocs}"
> author="true"
> version="true"
> windowtitle="${Name} API"
> doctitle="${Name}"
> bottom="Copyright © 2000 Apache Software Foundation.
> All Rights Reserved."
>
> link="http://java.sun.com/products/jdk/1.2/docs/api/;http://developer.java.sun.com/developer/products/xml/docs/api/"
>
> group="Ant Tools Packages;org.apache.tools.ant;Ant Task
> Packages;org.apache.tools.ant.taskdefs"
> packageList="src/etc/packagelist.txt"
> />
>
> I also attach a modified version of build.xml for ant and
> packagelist.txt (you should put it in src/etc)
> try ant javadocs on your ant tree with the patch and these 2 files, to
> see the result.
I don't like this.
The javadoc task was explicitly written to avoid to maintain a separate
package list or any external file.
> And let me know if you like the separator syntax: allowing 2 attributes
> with the same name would maybe be a better option, and an xml element
> for groups, with 2 attributes. It would be more readable. If you prefer
> this just let me know so that I can implement it.
I'd love to use XML for the whole thing and avoid in-string separator
syntax.
Something like:
<javadoc sourcepath="${src.dir}"
packages="org.apache.tools.ant.*"
destdir="${build.javadocs}"
author="true"
version="true"
windowtitle="${Name} API"
doctitle="${Name}"
bottom="Copyright © ${year} Apache Software Foundation.">
<link href="http://java.sun.com/products/jdk/1.2/docs/api/"/>
<link
href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
<group title="Ant Tools Packages" packages="org.apache.tools.ant"/>
<group title="Ant Task Packages"
packages="org.apache.tools.ant.taskdefs"/>
</javadoc>
with no external package list.
--
Stefano Mazzocchi One must still have chaos in oneself to be
able to give birth to a dancing star.
<[EMAIL PROTECTED]> Friedrich Nietzsche
--------------------------------------------------------------------
Come to the first official Apache Software Foundation Conference!
------------------------- http://ApacheCon.Com ---------------------