|
»
« Return to Thread: API Documentation Generation
Re: API Documentation Generation
by Helgi Þormar Þorbjörnsson-2
::
Rate this Message:
I had talked to Mike about using it primarily for PEAR1, PEAR2 would just be a side effect to be honest. Why? Because right now PEAR1 has more releases and thus more API doc generation and this is one of the parts of the system that spikes the CPU et all when it is being ran... And it hasn't been particularly stable :-)
I obviously would love to have it in both! Having met Mike in person and gotten a good hour and a half or two hour presentation of it and what can be done with it on the theming side, we should not hesitate to drop phpDocumentor (as good and bad it has done us through the years :P) for DocBlox.
As Mike demonstrated, he already created a basic theme for PEAR1, I'm sure we can improve on it a bit in terms of coloring, menu and other smaller items but all in all, impressive so far :-) Is anyone willing to help get this into PEAR1 and/or PEAR2?
- Helgi
On 13 Jun 2011, at 14:46, till wrote:
> +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@...> 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@...>wrote:
>>
>>> On Mon, Jun 13, 2011 at 12:20 PM, Mike van Riel
>>> <mike.vanriel@...> 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
>>>
>>>
>>
>
> --
> PEAR Development Mailing List (http://pear.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>
--
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
I obviously would love to have it in both! Having met Mike in person and gotten a good hour and a half or two hour presentation of it and what can be done with it on the theming side, we should not hesitate to drop phpDocumentor (as good and bad it has done us through the years :P) for DocBlox.
As Mike demonstrated, he already created a basic theme for PEAR1, I'm sure we can improve on it a bit in terms of coloring, menu and other smaller items but all in all, impressive so far :-) Is anyone willing to help get this into PEAR1 and/or PEAR2?
- Helgi
On 13 Jun 2011, at 14:46, till wrote:
> +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@...> 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@...>wrote:
>>
>>> On Mon, Jun 13, 2011 at 12:20 PM, Mike van Riel
>>> <mike.vanriel@...> 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
>>>
>>>
>>
>
> --
> PEAR Development Mailing List (http://pear.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>
--
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
« Return to Thread: API Documentation Generation
| Free embeddable forum powered by Nabble | Forum Help |
