From: Peter Cowburn [mailto:[email protected]] Sent: Thursday, March 19, 2015 9:28 AM To: Hollenbeck, Scott Cc: [email protected]; PHP Documentation ML Subject: Re: [PECL-DEV] PECL Package Documentation and docgen.php?
On 19 March 2015 at 12:41, Hollenbeck, Scott <[email protected]<mailto:[email protected]>> wrote: 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? Hopefully, the tutorial available at http://doc.php.net/ should be plenty to get you going with. It outlines the structure of the documentation, tools we use, and so on. It should also be much more up-to-date, in terms of having correct information. The two main source repositories that you will need are the English documentation, and "doc-base" which contains build and helper scripts. They're currently under SVN, and we have a module that you can use to check them both out at once... svn co http://svn.php.net/repository/phpdoc/modules/doc-en/ 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. Mails go to [email protected]<mailto:[email protected]> and you can subscribe via the form at http://php.net/mailing-lists.php [SAH] Thank you! Scott Hollenbeck
