Re: How to publish docs for a PECL package

On 3 Dec 2008, at 08:34, Elizabeth M Smith wrote:

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?)

Please test the process by following this new HOWTO: http://wiki.php.net/doc/scratchpad/pecldocs It's in the scratchpad because it's still being scratched out but it would be most excellent if someone new (and old) to the process would follow it and ask questions in order to help improve docgen and the HOWTOs. Feel free to edit the wiki entries too. And FWIW, Olivier was referring to xml_proto.php but within the last few months the reflection based docgen was created as a replacement. Regards, Philip