Re: API Documentation Generation
| From: | Matthew Fonda | Date: | Mon, 13 Jun 2011 20:08:34 +0000 |
| Subject: | Re: API Documentation Generation | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-54301@lists.php.net to get a copy of this message | ||
On Mon, Jun 13, 2011 at 12:20 PM, Mike van Riel
<mike.vanriel@naenius.com> wrote:
> Dear PEAR Developers,
>
> Please allow me to introduce myself first: I'm Mike van Riel and am the
> Lead Developer of DocBlox (http://www.docblox-project.org), which is a
> Documentation Generation Application inspired by phpDocumentor.
>
> At the past Dutch PHP Conference I had the pleasure of talking to Helgi
> and demonstrating DocBlox to him. During this demonstration it became
> apparent that DocBlox might have added value for PEAR2 and/or PEAR1.
>
> As such I wanted to approach you to see whether you are interested in
> using it?
>
> You can see a demonstration at
> http://demo.docblox-project.org/pear .
>
> I am available to create a template for both PEAR and PEAR2 (or assist
> with its creation).
>
> What DocBlox can offer is:
>
> * Faster and less memory intensive processing of the source code. Zend
> Framework has reduced their build time from 80 - 100 minutes down to 5
> to 10 minutes.
> * Incremental processing; if you keep the intermediate file then parsing
> speed can decrease with another 80% (transformation speed is unchanged).
> * Full support for PHP 5.3 (also works on PHP 5.2.6+ but can't process
> 5.3 projects then).
> * An active project with a new release with new improvements every
> month.
> * Backwards compatible with phpDocumentor DocBlock syntax and forwards
> compatible with new features (i.e. @api tag support).
>
> If you'd like you can view the source code at
> http://github.com/mvriel/docblox
>
> I am interested to hear your feedback!
>
> Thanks in advance,
>
> Mike van Riel
Hi Mike,
I think it would be great if DocBlox support could be integrated with
PEAR2. pear2.php.net currently has no API documentation generated.
I've opened a feature request [1] for it, and will start looking into
it. Any help would be greatly appreciated!
Cheers,
--Matthew
[1] https://github.com/pear2/pear2.php.net/issues/5