ant-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Rémon van Gijn <r.van.g...@portinfolink.com>
Subject RE: Commenting/generate documentation from an ant script
Date Mon, 22 May 2006 12:11:51 GMT

We went ahead and tried the http://antdoc.free.fr/ tool, Its quite nice for the general need,
make sure you let it start with your start build file, e.g. build.xml, and do not do a general
*.xml if you work with imports and property inheritance. It does not handle marcrodef links
as well. 
The tool isn't updated sincd ant 1.5 ,2003 so its bound to run into trouble with the latest
developments.

Met vriendelijke groet,
Rémon van Gijn


-----Original Message-----
From: Scot P. Floess [mailto:floess@mindspring.com] 
Sent: maandag 22 mei 2006 14:01
To: Ant Users List
Subject: Re: Commenting/generate documentation from an ant script

I will look into both of of these tools.  Thank you so much for the 
response :)

Varadarajan, Srivathsan wrote:
> This may just address some of your questions but FWIW, I happen to know
> specific tools that you are looking for. Never used them before myself
> though.
>
> For a tool to generate Javadocs for your Ant scripts - AntDoc
> (http://antdoc.free.fr/)
>
> For unit testing in Ant, check out AntUnit
> (http://ant.apache.org/antlibs/antunit/index.html)
>
> HTH
>
> -- Srivathsan
>
>   
>> -----Original Message-----
>> From: Scot P. Floess [mailto:floess@mindspring.com]
>> Sent: Friday, May 19, 2006 11:39 AM
>> To: Ant Users List
>> Subject: Commenting/generate documentation from an ant script
>>
>> I have what may be either a stupid questions or a silly ones...but I
>> can't find an answer (perhaps my google search is using the wrong key
>> words)...
>>
>> As part of one of my open source projects I am working on some (I
>>     
> hope)
>   
>> reusable Ant scripts.  I have some macro definitions, etc.  I was
>> wondering if there is any standard out there on how one should
>>     
> document
>   
>> macros?  Sorta like javadoc notation or some "preferred" way of
>>     
> internal
>   
>> documentation.
>>
>> Another question, is there a tool to generate java-doc like HTML
>>     
> against
>   
>> Ant scripts?  Or does one need to handcraft their own web pages?
>>
>> Final question (wow it just keeps going):  what about unit test cases
>> for one's Ant scripts.  For instance, supposing one writes macros -
>>     
> what
>   
>> do people do for unit test cases?  Presently, I have a script file
>>     
> that
>   
>> imports the macro scripts file and calls out to the macros...then I
>> evaluate properties, etc for accuracy.  However, I was wondering if
>> there is some "preferred" mechanism as well...
>>
>> Thanks again :)
>>
>> Scot
>>
>> --
>> Scot P. Floess
>> 27 Lake Royale
>> Louisburg, NC  27549
>>
>> 252-478-8087 (Home)
>> 919-754-4592 (Work)
>>
>> Chief Architect JPlate  http://sourceforge.net/projects/jplate
>> Chief Architect JavaPIM http://sourceforge.net/projects/javapim
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
>> For additional commands, e-mail: user-help@ant.apache.org
>>     
>
>
>
> **************************************************************
> This message, including any attachments, contains confidential information intended for
a specific individual and purpose, and is protected by law.  If you are not the intended recipient,
please contact sender immediately by reply e-mail and destroy all copies.  You are hereby
notified that any disclosure, copying, or distribution of this message, or the taking of any
action based on it, is strictly prohibited.
> TIAA-CREF
> **************************************************************
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
> For additional commands, e-mail: user-help@ant.apache.org
>
>
>   

-- 
Scot P. Floess
27 Lake Royale
Louisburg, NC  27549

252-478-8087 (Home)
919-754-4592 (Work)

Chief Architect JPlate  http://sourceforge.net/projects/jplate
Chief Architect JavaPIM http://sourceforge.net/projects/javapim



---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org


Mime
View raw message