Re: phpdoc generation
| From: | Ulf Wendel | Date: | Thu, 01 Feb 2001 20:28:26 +0000 |
| Subject: | Re: phpdoc generation | ||
| References: | 1 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-1235@lists.php.net to get a copy of this message | ||
"Stig S. Bakken" wrote:
> I think we should start generating PEAR docs with PHPDoc and put it
> online and update it regularly, preferably fully automated. I have had
> limited success with making PHPDoc parse most of PEAR's files though.
> Has anyone taken a look at this yet?
Sorry, guys for this delayed answer.
Several things have to do be done before PHPDoc can be used to
automatically generate source docs.
It starts with my duty to write docs. I did not manage to do that in the
past, let's see if I can find half an hour every day for that. The next
step is to revise all PEAR sources. I could do this or maybe Sebastian.
But he's busy with all the tests at the end of a semester in university
(and I won't allow you to tell him to work on that issue as I need his
manpower for something else ;-)).
Now the PHPDoc extension has to be finished. We need my colleague Jan
(http://www.kneschke.de/who_is_who/jan_kneschke/ - Author of ModLogAn,
ggitv) for this. As soon as Jan finished his work (which means that I
have to spend him a several pizzas), several Zend files have to be
modified to make some functions public (no longer static), Sterling has
to be told that it's sexy to modify PHPDoc to use the Extension and
finally Hartmut should be given several six-packs (hope he likes beer)
and a message that asks him to write some magic XSLT that converts the
PHPDoc XML to DocBook which I use to generate HTML and PDF.
Ok, that the (former secret) battle plan.
This is not the answer you expected, right? Ok, for some time I could
create - say weekly - HTML Docs from the CVS. These could be placed
everywhere and be offered for download as well. For the hardcore guys I
could create a quick and dirty howto generate the docs by themself. How
about that?
Ulf