Re: Documentation for an extension
| From: | sumoraigabe-pecl at yahoo dot com | Date: | Thu, 01 Jul 2004 16:53:22 +0000 |
| Subject: | Re: Documentation for an extension | ||
| References: | 1 | Groups: | php.pecl.dev |
| Request: | Send a blank email to pecl-dev+get-931@lists.php.net to get a copy of this message | ||
--- Hartmut Holzgraefe <hartmut@php.net> wrote:
> sumoraigabe-pecl@yahoo.com wrote:
> > So, would it be correct to write documentation
> like
> > that found in peardoc/en/pecl ? Or should it be
> > written like in the html-parser extension
> > (html-parser/manual/)?
> >
>
> the style of html-parser documentation should be
> similar in style to any of the extensions on phpdoc
> so you could just move the
> html-parser/manual/html-parser
> directory to phpdoc/en/reference, run configure and
> make and have the documentation in the regular
> manual
>
> the reason why it is bundled with the extension in
> this case is that it was generated together with the
> source using PECL_Gen
Sorry for being ignorant, but what is PECL_Gen?
> IMVHO this is they way it should be for all PECL
> extensions in the long run as maintaining source
> and docs in two different repository with a 1:n
> relationship between docs and source just doesn't
> make sense at all
> (having to check out *all* phpdoc while you only
> use one PECL extension ...)
Ok, good, because I just copied the html-parser/manual
directory and modified it to fit my extension.
- Gabriel
=====