eddiejaoude / Zend-Framework--Doctrine-ORM--PHPUnit--Ant--Jenkins-CI--TDD-

[DEPRECATED for ZF2 & Composer] Best practice Zend Framework (ZF) skeleton / base with Doctrine2 integration : High code coverage & build scripts using TDD. Issues section ar e used for project planning (features etc)
http://www.jaoudestudios.com
160 stars 40 forks source link

Alternate Documentation Generator - DocBlox #75

Closed michaelalber closed 12 years ago

michaelalber commented 12 years ago

DocBlox is mentioned as an alternative documentation generator for Zend Framework. DocBlox is a PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration. Here are a few places where Zend and DocBlox are talked about (or used):

Using DocBlox - http://weierophinney.net/matthew/archives/265-Using-DocBlox.html Zend Framework 1.11.5 Released - http://devzone.zend.com/article/13643 DocBlox v0.10.0 - http://www.docblox-project.org/2011/05/release-of-v0-10-0/ Zend Framework API Docs - http://framework.zend.com/apidoc/1.11/

Here is an alternative phpdoc target (build.xml), assuming DocBlox has been installed `<target name="phpdoc" description="Generate API documentation using DocBlox">

</target>`

DocBlox Documentation - http://www.docblox-project.org/

eddiejaoude commented 12 years ago

Is DocBlox much better than the traditional phpDocumentor?

michaelalber commented 12 years ago

I've just read a few things about it being used by Zend, and blog posts like this http://www.dragonbe.com/2011/08/quality-assurance-on-php-projects.html Michelangelo van Dam has given talks at Zend/PHP Con so I assume that he is a valid / good source for info. Basically it seems the DocBlox is faster and support PHP 5.3 features like name spaces.

On Mon, 2011-09-05 at 10:30 -0700, eddiejaoude wrote:

Is DocBlox much better than the traditional phpDocumentor?

Michael K. Alber Chief Software Developer ONE2Market LLC 182 Howard St #136 San Francisco, CA 94105 USA malber@one2market.com http://www.one2market.com

Follow me on twitter: @malber_o2m Follow ONE2Market on twitter: @one2market

eddiejaoude commented 12 years ago

Sounds good.

eddiejaoude commented 12 years ago

Done. I have installed docblox on the build server. Now docblox & phpdoc are both generated on the build server - the advantage of this, other developers can compare the differences.

When they run it locally the developer can choose which one to use, however docblox is the new kid on the block & getting real traction.