Re: Todo: * implement javadoc based function docs template system.
| From: | Ulf Wendel | Date: | Tue, 13 Jun 2000 14:31:20 +0000 |
| Subject: | Re: Todo: * implement javadoc based function docs template system. | ||
| References: | 1 2 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-112@lists.php.net to get a copy of this message | ||
Andrei Zmievski wrote:
>
> On Tue, 13 Jun 2000, Ulf Wendel wrote:
> > Hi!
> >
> > Can anyone give me more informations on that point? Should I stop
> > working on a php based javadoc adaption
> > (http://www.redsys.de/phpdoc/) ?
>
> Don't take that TODO item too seriously. It's just something we've
> discussed. If we have a couple of different javadoc based tools, it's
> still good.
Puh - good to hear that. So I don't have to throw away two weeks
of work and 4k+ loc. Is there a public source where I can see the
discussion, is it on the php-dev list?
Now that the URL is public lets look at the features I want to
implement before I call it "beta":
- generate more index files
- generate reports
- export DocBook
- export it's own XML
- export WDDX
- make it possible to run it on the command line
- improve the code analyser
- reduce memory usage (specially on 64bi machines)
- improve speed (scans now ~750 lines per second on a P200MMX
with PHP4)
- add a gui (gui: dog, parser: doc, together: phpdoc)
I don't know what the gui will look like. Goeran Zaengerlein
orginially wrote a gui (without a parser) to document it's source
in several languages. That's a feature I do not rate very high. I
would preferr a gui with some kind of "source feedback" to make
it easy to correct the warnings and errors (undocumented
function, description does not math source etc.) the parser
reported.
There's one point I need input: How can we integrate any phpdoc
system that generates api documentation of pear packages in the
DocBook system of php.net?
Today I'm thinking of a DocBook import module in the gui (dog)
that updates the php (package, script) source using some
conversion rules. Once the inline documentation in the source has
been updated the parser (doc) can extract it together with the
features found in the source and generate a new docbook document
that contains the old and the new features.
Ulf
--
Ulf Wendel
NetUSE Kommunikationstechnologie GmbH
Siemenswall, D-24107 Kiel, Germany
Fon: +49 431 386435 00 -- Fax: +49 431 386435 99