Re: How to publish docs for a PECL package
| From: | Elizabeth M Smith | Date: | Wed, 03 Dec 2008 16:34:56 +0000 |
| Subject: | Re: How to publish docs for a PECL package | ||
| References: | 1 2 3 | Groups: | php.pecl.dev |
| Request: | Send a blank email to pecl-dev+get-5951@lists.php.net to get a copy of this message | ||
Hannes Magnusson wrote:
> On Wed, Dec 3, 2008 at 14:51, Olivier Hill <ohill@php.net> wrote:
>> On Wed, Dec 3, 2008 at 7:43 AM, Christian Hammers <ch@lathspell.de> wrote:
>>> 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 :)
>
> http://cvs.php.net/viewvc.cgi/phpdoc/scripts/docgen/ (uses
> reflection)
>
> Then "fill in the blanks" and remove not used sections
> (role="changelog", role="unicode", role="errors"..) if any.
> Note: Do not remove the role="parameters" section, even if the
> function doesn't take arguments. use the &no.function.parameters;
> entity.
>
> See also
> http://news.php.net/php.pecl.dev/5854 and
> http://news.php.net/php.pecl.dev/5872
>
> -Hannes
Hmm, great information, this should probably be put somewhere that
people can find it easily (wiki at least?)
Thanks,
Elizabeth