PECL Package Documentation and docgen.php?
| From: | Hollenbeck, Scott | Date: | Thu, 19 Mar 2015 12:41:22 +0000 |
| Subject: | PECL Package Documentation and docgen.php? | ||
| Groups: | php.pecl.dev | ||
| Request: | Send a blank email to pecl-dev+get-12689@lists.php.net to get a copy of this message | ||
I'm in the process of writing PHP language bindings for the getdns API
(http://www.getdnsapi.net/) using the Zend engine to create a PHP extension. I'd like to create
documentation in a form that makes sense for PHP developers. Someone suggested submitting the
project to PECL and using this community's processes to produce the documentation. I thought
that sounded like a great idea, so I've been doing my homework and trying to figure out what
those processes are. One resource I found (https://wiki.php.net/doc/scratchpad/pecldocs) says
"Checkout the CVS module named 'phpdoc'" and "Generate the documentation
skeletons" using docgen.php. I've been trying to find the CVS repository for phpdoc
without much luck. I found http://www.phpdoc.de/ and http://www.phpdoc.de/cvs.html, but the repository links
are all broken.
So, what *is* the best/correct way to create the documentation for my extension? Where can I find
the needed tools?
I found this message in this mailing list's archive:
http://marc.info/?l=pecl-dev&m=135145307328713&w=2
How does one reach the "phpdoc folks"? I found the svn repo containing the documentation,
but I couldn't find any scripts.
Thank you,
Scott Hollenbeck