Release of v0.18.0
Posted on | January 7, 2012 | 2 Comments
I wish you a happy new year! In the past month we haven’t sat still but got around to fixing some longstanding issues and giving some love to the documentation.
The documentation is one of the points where DocBlox wants to excel; and in order to do this we need to write loads more of it. In the past month we have kickstarted this effort and re-arranged some of the sections and added loads of new content. You can see that at http://docs.docblox-project.org.
Below is listed some of the other things that were achieved in the past month:
- Documentation is greatly improved
- Code has been cleaned up; it is now compliant with the PEAR Coding Standards and several missing or incorrect docblocks were fixed.
- Added more validations for your docblocks:
- If an @param has no matching argument
- If an argument has no @param
- If the type of an @param mismatches with the given argument
- Added a new option: ignore-tags, with this option you can filter unwanted tags from your output
- Added a new option: hidden, with this option you can prevent DocBlox from processing files in hidden directories
- Added a new option: ignore-symlinks, whether to traverse into symlinks (default is to ignore symlinks)
- Separated Reflection into the actual parsing and the exporting of XML so that it may become possible that reflection is a separate component and other output formats may be supported in the future
- The structure file is now timestamped, which can be displayed in a template
- Properties that contained array definitions had their default shown incorrectly
- You can now output the parser output to a specific filename (instead of the default structure.xml) in addition to the old way of specifying only a folder where to send the output to.
There is more that is fixed and added but these are the highlights of the past month.
Next release: February 4th
Next release will be on February 4th, where we will try to improve the Code Coverage, documentation and solve a fair deal of the issues in the bug tracker.
Until then and thank you for using DocBlox!
Tags: coding standard > documentation > exporters > fixes > hidden > ignore-symlinks > ignore-tags > options > reflection > validations
Comments
2 Responses to “Release of v0.18.0”
Leave a Reply
January 8th, 2012 @ 8:30 pm
When I try to use v0.18 with PHP 5.3.8 (CLI mode) I get the following warning numerous times:
PHP Warning: preg_replace_callback(): Compilation failed: POSIX collating elements are not supported at offset 157 in /usr/share/php5/PEAR/DocBlox/src/markdown.php on line 1005
After that a lot of loadXML() warning:
PHP Warning: DOMDocument::loadXML(): Entity ‘Atilde’ not defined in Entity, line: 179 in /usr/share/php5/PEAR/DocBlox/src/DocBlox/Parser.php on line 246
Finally it stops with:
PHP Fatal error: Call to a member function getAttribute() on a non-object in /usr/share/php5/PEAR/DocBlox/src/DocBlox/Parser.php on line 132
Here is the full log, when I run it in a completely empty folder: http://pastebin.com/VvYrnGvK
January 12th, 2012 @ 12:41 pm
This is an unforeseen error in 0.18; 0.18.1 has been released to fix this bug.