ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jesse Glick <Jesse.Gl...@netbeans.com>
Subject [PATCH] Permit more nested elements in <javadoc>
Date Thu, 03 May 2001 21:58:18 GMT
This patch lets more options to <javadoc> be specified as nested elements
rather than attributes. Docs patch included.

For one thing, nested elements permit text content model, which makes it much
clearer to specify complex or lengthy HTML text in e.g. the -footer argument.
Instead of:

<javadoc ... footer="&lt;b&gt;Text...&lt;/b&gt;"/>

you can have:

<javadoc ...>
    <footer><![CDATA[
        <b>Text...</b>
    ]]></footer>
</javadoc>

For another thing, many complicated options otherwise require un-XML-like
arbitrary syntax: lists of strings separated by commas, colons, etc. Now you
can list each parameter as a subelement, which could be clearer to some
tastes. E.g. rather than:

<javadoc ... packages="foo,bar"/>

you can have:

<javadoc>
    <package name="foo"/>
    <package name="bar"/>
</javadoc>

This may also be useful for <source file="resolved/by/Basedir.java"/>.

Third, rather than e.g. private="true", you can specify access="private" or
similar, with an enumerated list of values for 'access', which is probably
more intuitive.

Tested only casually, but seems to work. Attaching sample build file showing
before and after versions. A test case for <javadoc> might be useful but I am
not sure what exactly it ought to test.

-Jesse

-- 
Jesse Glick   <mailto:Jesse.Glick@netbeans.com>
NetBeans, Open APIs  <http://www.netbeans.org/>
tel (+4202) 3300-9161 Sun Micro x49161 Praha CR
Mime
View raw message