ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Chris Todd" <ch...@christophertodd.com>
Subject RE: documenting your build file
Date Thu, 19 Oct 2000 08:48:20 GMT
Hmmm, this is an interesting idea.  I suppose the easiest way to do this
would be to create a new Ant Task that interprets a tag like <doc> or
<builddoc> and have the contents of that tag formatted into HTML or whatever
format you want.

Alternatively, if Ant will tolerate having tags in build.xml that it doesn't
know about (my guess is it would not - is that correct?), then you could
include <doc> tags in your build.xml, then simply transform build.xml into
HTML (or whatever) using an XSL stylesheet.  Actually, can an XSL stylesheet
recognize XML comments <!-- --> and transform them (sorry, I left my XML/XSL
book at work)?  If so, then you could just comment your build.xml normally
and transform it with such a stylesheet.

Sincerest regards,
Chris Todd
Software Engineer
Alabanza Corporation
ctodd@alabanza.com

-----Original Message-----
From: Julian M. Savage [mailto:jsavage@fisci.com]
Sent: Thursday, October 19, 2000 4:16 AM
To: ant-dev@jakarta.apache.org
Subject: documenting your build file


Is there a way that I can easily generate documentation from my build file
for developers who use it? Basically what I want is javadoc like
functionality of some sort. Is there an easy way to do this somehow?

Thanks,

Julian.


Mime
View raw message