RE: [PHP-DOC] PEAR Documentation?
| From: | Sterling Hughes | Date: | Tue, 21 Nov 2000 20:13:36 +0000 |
| Subject: | RE: [PHP-DOC] PEAR Documentation? | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969333035@lists.php.net to get a copy of this message | ||
That is a project I have here at Pentap (modifying PHPDoc to output Docbook
XML), however, all I can really say is that I'm working on it, I don't have
any idea of when I'll actually get around to it. It'd be swell if someone
got around to doing it before I have to ;).
I think perhaps we should be a little reluctant to document the PEAR classes
in the online manual itself. Perhaps build another repository for PEAR
documentation (with a note that PEAR code is distributed with PHP at the
moment). Then link to this repository in the online manual...
-Sterling
-----Original Message-----
From: Rasmus Lerdorf [mailto:rasmus@linuxcare.com]
Sent: Wednesday, November 22, 2000 10:00 PM
To: Sterling Hughes
Cc: phpdoc@lists.php.net
Subject: Re: [PHP-DOC] PEAR Documentation?
Well, all the PEAR stuff is currently being distributed since it is
installed alongside PHP 4. So we really do need it documented in the
online manual. I am well aware of the inline PHPdoc stuff and was hoping
that someone was working on something that would generate docbook-xml from
the PHPdoc stuff.
-Rasmus
On Wed, 22 Nov 2000, Sterling Hughes wrote:
> PEAR documentation is currently in the source code using the PHPdoc
(similiar
> to Javadoc) documentation system. When packages are distributed through
the
> PEAR web site or a similair distribution system they should come with
their
> own hand written documentation as well as the Javadoc documentation. The
hand
> written documentation would be in the form of either docbook or html or
both.
>
>
> -Sterling
>
>
> >What is the status of the PEAR documentation? I haven't really been
> >paying enough attention in this area. Someone developed some scripts to
> >extract the inline docs and bring it out into something useful. What
> >exactly does it do and how do you see this integrating with our
> >docbook-xml setup for the online docs?
> >
> >-Rasmus
> >
> >
> >
>