Mailing-List: contact user-help@ant.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Ant Users List" <user@ant.apache.org>
Received-SPF: pass (asf.osuosl.org: local policy)
Content-class: urn:content-classes:message
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
Subject: RE: Commenting/generate documentation from an ant script
Date: Fri, 19 May 2006 12:18:23 -0400
Message-ID: 
 <457511D705306A4E88F49DD56EC29F880290AE23@CHAPDMSXMB04.ad.tiaa-cref.org>
Thread-Topic: Commenting/generate documentation from an ant script
Thread-Index: AcZ7WmdS5DaLIr3FTcmrD178Hup75gABF+vg
From: "Varadarajan, Srivathsan" <SVaradarajan@tiaa-cref.org>
To: "Ant Users List" <user@ant.apache.org>

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
>=20
> 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)...
>=20
> 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.
>=20
> 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?
>=20
> 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...
>=20
> Thanks again :)
>=20
> Scot
>=20
> --
> Scot P. Floess
> 27 Lake Royale
> Louisburg, NC  27549
>=20
> 252-478-8087 (Home)
> 919-754-4592 (Work)
>=20
> Chief Architect JPlate  http://sourceforge.net/projects/jplate
> Chief Architect JavaPIM http://sourceforge.net/projects/javapim
>=20
>=20
> ---------------------------------------------------------------------
> 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.  I=
f you are not the intended recipient, please contact sender immediately by =
reply e-mail and destroy all copies.  You are hereby notified that any disc=
losure, copying, or distribution of this message, or the taking of any acti=
on 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