Release of v0.14.0

Posted on | September 4, 2011 | 6 Comments

Wow! Past month has been quite a ride. During this time we managed to add quite some features and improvements to DocBlox. Most notably we added support for Doctrine Annotations. They are parsed, displayed nicely and a link is provided to the Doctrine Documentation. But there is more!

The changelog of the past month shows a great deal of activity. We have received support and contributions from several people in the community, big kudos to you!

Let’s pick the top items from the list (in no specific order):

• Doctrine Annotations are recognized, their arguments parsed, styled and a link created to the Doctrine Annotation.
• A refactoring of the core components took place to make each a truly separate entity. They are bound by an EventDispatcher; which can be used by the user to tie in his or her own code! Documentation and more hooks will follow in the next months.
• Backwards compatibility break: most of DocBlox’ users won’t be affected but we changed the way the DocBlox_Parser class receives files and folders; it now uses a File container to collect all files and directories and to know which ones are ignored. If you use the DocBlox_Parser class directly, then a change is necessary.
• The way the ‘project root‘ is determined (the directory from where to look for ignored files) is changed; most won’t notice but if only 1 directory is provided then this is used as the project root, instead of the first subdirectory where a PHP file is found.
• The {@inheritdoc} inline tag can now also be used in the Short description, if used then the Long Description will also have it’s description augmented
• Support for the {@internal … }} inline tag; contents in this tag will only be shown if the –parseprivate argument is used during parsing
• Several aesthetic fixes to the class view
• New option `default-package-name` in the command line and configuration, this is used to change the package name for elements without package associated
• It is now possible to link to an external documentation using the `external-class-documentation` configuration element, you can define a class prefix and have it link to a predefined path
• The @method magic tag is now supported and those magic methods are added to the class view
• By default protected and private members are now hidden from the class view; toggle buttons in the upper right corner provide a way to filter members based on visibility or whether they are inherited.
• Properties are now also shown as inherited members

Quite a bit of other improvements and fixes have been made, to see a list please consult the CHANGELOG in the docs folder.

The upcoming month will probably see less improvements as we are going to spend time on performance optimalization, improving code coverage (60% now) and finishing the migration of the Coding Standards to PEAR. In addition several fixes are planned as some features could use some polish and updating.

I hope to see you again in the weekend of 1/2 October for release 0.15.0!

Happy documenting!

Comments