Re: How to publish docs for a PECL package
| From: | Olivier Hill | Date: | Wed, 03 Dec 2008 13:51:16 +0000 |
| Subject: | Re: How to publish docs for a PECL package | ||
| References: | 1 | Groups: | php.pecl.dev |
| Request: | Send a blank email to pecl-dev+get-5949@lists.php.net to get a copy of this message | ||
On Wed, Dec 3, 2008 at 7:43 AM, Christian Hammers <ch@lathspell.de> wrote:
> Hello
>
> I'm wondering how to write docs for a PECL package that currently only
> has a README file.
That's good news! End user doc is always a Good Thing.
> Some packages have a "View Documentation" link on
> http://pecl.php.net/package that points to php.net/package but
> those
> docs seem to be in a hard to write docbook xml format and need CVS
> write commit to get published.
It's part of the main manual. If you don't have karma, you can always
send patches here and the doc list. Some people will be able to commit
that for you.
> Isn't it possible that the pecl archive automatically extracts the API
> specs using phpdoc, doxygen or the "proto" lines and generate an HTML
> API documentation?
Yes, there is a script that extract proto lines and generates valid
XML Docbook skeleton :)
Not sure about how it works now with PhD and the rest. You could
always ask on the doc mailing list, they will let you know how to
proceed.
Regards,
Olivier