You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@ant.apache.org by Evgeny Goldin <ev...@gmail.com> on 2005/11/17 18:54:08 UTC
Ant HTML documentation generation
Hi,
After browsing and searching this mailing list it appears to me that Ant's
HTML documentation was and still is coded by hand.
Am I right ? The reason I'm asking this question is because I would like to
generate an Ant-like HTML documentation for the
custom Ant components that we develop internally and coding all HTMLs by
hand just doesn't seem good to me.
So before I'm starting to develop some process which will generate those
HTML files automatically (from either XML or Javadocs)
I wanted to make sure there's no such a tool available yet .. Is anybody
here aware of something like that ?
Thank you !
Re: Ant HTML documentation generation
Posted by Evgeny Goldin <ev...@gmail.com>.
Hi,
Good, I'm glad to hear something is done about it. I think I'll give
Dominique's XSL system a try.
Thank you !
On 11/17/05, Antoine Levy-Lambert <an...@gmx.de> wrote:
>
> Hello Evgeny,
> we have a system - which is not used yet - where we would extract the
> documentation from the tasks using xdoclet,
> then further process the output with stylesheets.
> you can see it there :
> http://svn.apache.org/viewcvs.cgi/ant/core/trunk/proposal/xdocs/
>
> And Dominique Devienne has also prepared something which is in bugzilla :
> http://issues.apache.org/bugzilla/show_bug.cgi?id=34116
>
> BTW : Dominique, how does your proposal in bugzilla articulate with the
> xdocs proposal of Eric/Steve ?
> Is it complementary/parallel/concurrent ?
>
> Cheers,
> Antoine
>
> Evgeny Goldin wrote:
>
> >Hi,
> >
> >After browsing and searching this mailing list it appears to me that
> Ant's
> >HTML documentation was and still is coded by hand.
> >Am I right ? The reason I'm asking this question is because I would like
> to
> >generate an Ant-like HTML documentation for the
> >custom Ant components that we develop internally and coding all HTMLs by
> >hand just doesn't seem good to me.
> >So before I'm starting to develop some process which will generate those
> >HTML files automatically (from either XML or Javadocs)
> >I wanted to make sure there's no such a tool available yet .. Is anybody
> >here aware of something like that ?
> >
> >
> >Thank you !
> >
> >
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
> For additional commands, e-mail: user-help@ant.apache.org
>
>
Re: Ant HTML documentation generation
Posted by Dominique Devienne <dd...@gmail.com>.
> BTW : Dominique, how does your proposal in bugzilla articulate with the
> xdocs proposal of Eric/Steve ?
> Is it complementary/parallel/concurrent ?
I'm afraid it's concurrent. I want to:
1) use Ant's own IH, as opposed duplicated logic in the doc code.
2) use regular doclets as opposed to xdoclet.
3) use XSL (Saxon probably to benefit from XSL 2.0) instead of Velocity/Anakia.
I extend IH already to extract the info I need (covers (1)). I've
prototyped the XML vocabulary the doc could follow, and this was
discussed in the list in while back. Remains to do (2), and finish up
(3).
The trouble of course is that I haven't done much to it for a long
time... I need to. I'm currently concentrating on finding a job though
;-) --DD
---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org
Re: Ant HTML documentation generation
Posted by Steve Loughran <st...@apache.org>.
Antoine Levy-Lambert wrote:
> Hello Evgeny,
> we have a system - which is not used yet - where we would extract the
> documentation from the tasks using xdoclet,
> then further process the output with stylesheets.
> you can see it there :
> http://svn.apache.org/viewcvs.cgi/ant/core/trunk/proposal/xdocs/
>
> And Dominique Devienne has also prepared something which is in bugzilla :
> http://issues.apache.org/bugzilla/show_bug.cgi?id=34116
>
> BTW : Dominique, how does your proposal in bugzilla articulate with the
> xdocs proposal of Eric/Steve ?
> Is it complementary/parallel/concurrent ?
>
> Cheers,
> Antoine
>
The existing xdoclet stuff needs a lot of maintenance. It works badly
for ant's own docs, and very badly for third party stuff.
---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org
Re: Ant HTML documentation generation
Posted by Antoine Levy-Lambert <an...@gmx.de>.
Hello Evgeny,
we have a system - which is not used yet - where we would extract the
documentation from the tasks using xdoclet,
then further process the output with stylesheets.
you can see it there :
http://svn.apache.org/viewcvs.cgi/ant/core/trunk/proposal/xdocs/
And Dominique Devienne has also prepared something which is in bugzilla :
http://issues.apache.org/bugzilla/show_bug.cgi?id=34116
BTW : Dominique, how does your proposal in bugzilla articulate with the
xdocs proposal of Eric/Steve ?
Is it complementary/parallel/concurrent ?
Cheers,
Antoine
Evgeny Goldin wrote:
>Hi,
>
>After browsing and searching this mailing list it appears to me that Ant's
>HTML documentation was and still is coded by hand.
>Am I right ? The reason I'm asking this question is because I would like to
>generate an Ant-like HTML documentation for the
>custom Ant components that we develop internally and coding all HTMLs by
>hand just doesn't seem good to me.
>So before I'm starting to develop some process which will generate those
>HTML files automatically (from either XML or Javadocs)
>I wanted to make sure there's no such a tool available yet .. Is anybody
>here aware of something like that ?
>
>
>Thank you !
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org