News Feed
Jobs Feed
Sections




News Archive
Matthew Weier O'Phinney's Blog:
Using DocBlox
August 04, 2011 @ 08:08:36

On his blog today Matthew Weier O'Phinney has a new post looking at an alternative to some of the other PHPDoc-based documentation tools, DocBlox, a tool written in PHP.

Until a few years ago, there were basically two tools you could use to generate API documentation in PHP: phpDocumentor and Doxygen. [...] phpDocumentor is practically unsupported at this time (though a small group of developers is working on a new version), and Doxygen has never had PHP as its primary concern. As such, a number of new projects are starting to emerge as replacements.

He introduces DocBlox as one of these alternatives and points out where you can get the latest version (from one of many sources including github, PEAR or by just grabbing a release. He includes instructions on how to run the tool on your code, use it to identify missing docblock comments and how to use the class diagrams feature that gives a more visual sense of how things fit together. He also mentions changing the title of the output, using different templates and how it uses a local SQLite database to cache the parsed information about your code (making it simpler and faster to do updates in the future).

0 comments voice your opinion now!
docblox docblock comment parse introduction


blog comments powered by Disqus

Similar Posts

IBM developerWorks: Mastering regular expressions in PHP, Part 1

Chris Tankersley's Blog: Playing with Lithium

DevShed: Integrate Facebook Comments Code with Wordpress or PHP

PHP in Action: How harmful is "harmful"?

PHPBuilder.com: The ABC's of PHP Part 4 - How Variable Am I?


Community Events











Don't see your event here?
Let us know!


object series unittest opinion application functional community podcast code language framework example development phpunit tool testing interview introduction zendframework2 release

All content copyright, 2013 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework