Re: Documentation for an extension

On Mon, Jun 17, 2013 at 11:22 AM, Jeroen Moors <jeroen.moors@fluoline.net>wrote: > Hi, > > I'm new to the list, so I hope this is the right place to ask my question, > if not, my excuses! > > Currently I'm working on a PHP extension for Ceph ( > > https://github.com/ceph/phprados/<https://github.com/ceph/phprados/tree/oo-interface>).It's > not yet ready to be adopted by PECL. > > I would like to create already some documentation on it's API, preferably > in such a way that if one day it's moving upstream a could reuse the > existing documentation. > > I've already did some research about which tools could be used, but it's > still a bit unclear to me what's currently the best way to go. > > Any advice is welcome! > You could start here https://wiki.php.net/doc/scratchpad/pecldocs where there is a guide for building pecl docs in the wiki. Currently pecl extensions are documented along with the regular PHP documentation available at php.net so you would need to get familiar wtih phd and the toolchain used there. So these links may come in handy as well https://wiki.php.net/doc/articles and https://wiki.php.net/doc/phd Good luck. > > Thanks! > > Jeroen >