Re: API Documentation Generation
| From: | till | Date: | Mon, 13 Jun 2011 21:46:40 +0000 |
| Subject: | Re: API Documentation Generation | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-54303@lists.php.net to get a copy of this message | ||
+1
And I think we should also consider using it for PEAR1. I've toyed
with it in house and it's pretty impressive how fast our documentation
builds now and also how resource efficient this is. I think PEAR1
would benefit from this as well.
@Mike: I cc'ed pear-group@ on this email, maybe someone can +1/-1 if
they would like a tempate for PEAR1. If you're offering, I don't see
any issues though!
Till
On Mon, Jun 13, 2011 at 10:37 PM, Bill Shupp <hostmaster@shupp.org> wrote:
> I've been impressed with how quickly this project is moving forward. (All
> my requests have been addressed in a very timely fashion as well). I would
> endorse moving PEAR2 over to it as well.
>
> Cheers,
>
> Bill
>
> On Mon, Jun 13, 2011 at 1:08 PM, Matthew Fonda <matthewfonda@gmail.com>wrote:
>
>> 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
>>
>> --
>> PEAR Development Mailing List (http://pear.php.net/)
>> To unsubscribe, visit: http://www.php.net/unsub.php
>>
>>
>