Re: Regarding the use of PhD and docgen for extensions.
| From: | Philip Olson | Date: | Thu, 14 Oct 2010 18:36:07 +0000 |
| Subject: | Re: Regarding the use of PhD and docgen for extensions. | ||
| References: | 1 | Groups: | php.pecl.dev |
| Request: | Send a blank email to pecl-dev+get-7764@lists.php.net to get a copy of this message | ||
On Oct 14, 2010, at 11:23 AM, Mark Skilbeck wrote:
> I'm unsure how to use PhD on the XML generated by docgen.php.
>
> This is as far as I have gotten:
> 1. php docgen.php -e myextension
> ... XML generated
>
> Heh. How do I then proceed to use PhD on these XML files?
That generates the reflection based skeletons, and now the PHP documentation needs to know about
them. Check this out:
- http://wiki.php.net/doc/howto/pecldocs
It also mentions that you should be passing in --pecl to docgen.php for PECL extensions, because it
adds some PECL specific goodies. It also briefly mentions the requirement to edit manual.xml.in but
the FAQ should help too:
- http://wiki.php.net/doc/howto/faq
In summary: You need to add the extension to doc-base/manual.xml.in and then both configure.php and
phd will look for it. And just in case, your directory needs to live within en/reference/.
Regards,
Philip