Re: API Documentation Generation
| From: | Mike van Riel | Date: | Fri, 29 Jul 2011 21:33:38 +0000 |
| Subject: | Re: API Documentation Generation | ||
| References: | 1 2 3 4 5 6 7 8 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-54417@lists.php.net to get a copy of this message | ||
On Fri, 2011-07-29 at 09:16 +0930, Daniel O'Connor wrote:
> >
> > >
> > > What's required to set it up on test.pear.php.net?
> >
> > Is the build script / command somewhere available for me to look at?
> > That will help me to determine what changes are necessary.
> >
> >
>
> http://svn.php.net/viewvc/pear/pearweb/trunk/cron/apidoc-queue.php?view=markup
Thank you for providing that link.
I have taken a look and notice that DocBlox currently does not (yet ;))
support 3 of the command line arguments:
1.
Attachment: [text/x-patch] apidoc-queue.patch
Attachment: [text/x-patch] apidoc-queue-test.patch
dn, DocBlox currently does not provide the possibility to specify
the name of the default package; it is always Default
2. p, PEAR mode is quite specific to phpDocumentor and is currently
not implemented
3. s, There is no implementation at the moment for this option.
I can imagine that these options are required for PEAR to adopt DocBlox
and would like to ask feedback whether the options above are indeed
still desirable.
With this mail I have attached a minimal patch (apidoc-queue.patch) with
which API Docs can be generated through DocBlox; the theme 'pear' which
is mentioned here is not provided with a default DocBlox installation.
For testing purposes I recommend substituting the theme pear with
default to get an idea (see attached patch apidoc-queue-test.patch).
I am interested to hear your feedback!
Mike
Attachment: [text/x-patch] apidoc-queue.patch
Attachment: [text/x-patch] apidoc-queue-test.patch