Release of v0.10.0
Posted on | May 8, 2011 | 8 Comments
About a month ago had Zend Framework launched their new API Documentation using DocBlox v0.9. A large amount of feedback came from this (of which not all was positive) and we listened to every bit of it.
After the dust had settled it was clear that the layout of DocBlox did not satisfy users and it even left some of them annoyed, bewildered and/or confused.
This called for Action!
Now, I would like to present to you DocBlox v0.10.0!
In this version we have made a huge amount of changes first and foremost in the layout of DocBlox but also quite a bit of other features were implemented and contributed.
A demo of the new version can be found at http://demo.docblox-project.org/default.
Allow me to give a quick summary of the changes since v0.9.0:
- A brand new shining spunky super-duper-delicious template! (At least; we think so
) - The Class Inheritance Diagram now supports panning and zooming
- The sidebar now also shows:
- A list of files and their contents
- The functions contained in a package or namespace
- A list of elements which are marked as API using the @api tag (as described in: http://fabien.potencier.org/article/47/pragmatism-over-theory-protected-vs-private). BIG thanks to Ben Selby (@benmatselby) for contributing this feature!
- Support for the @link tag
- A completely re-vamped Task Runner
- PEAR package no longer includes the dependencies but has a link to the required PEAR packages.
- Templates can now be housed outside of the DocBlox directory structure. Handy when you have your own template!
Although we have no benchmarks to support it, the performance for creating HTML files seems to have improved significantly.
For a more detailed list of changes, please consult the CHANGELOG in the docs folder.
Credits
More than a dozen people have contributed their ideas, feedback and code in the past month. Without them it would not have been the same release.
A big, big, thank you is in order here!
Finally
Try it out, play with the new release and send your experiences to me. If there is anything lacking, or you particularly like a certain feature, let me know!
In the upcoming month we will be working on expanding the documentation (we know, it really needs some attention), fixing the last few (known) bugs, improving the performance of the frontend, adding new features and support for new tags. Watch this space as next month will bring v0.11.0!
Comments
8 Responses to “Release of v0.10.0”
Leave a Reply
May 8th, 2011 @ 8:37 pm
congratulation and thanks for your efforts for creating DocBlox.
it was much needed
Tyrael
May 9th, 2011 @ 5:12 pm
There is a problem with building the docs on windows. I managed to track it down to the DocBlox_Transformer_Writer_Xsl::transform() method.
It calls XSLTProcessor::transformToUri() assuming we’re on a *nix system. I got it to work by prepending an additional ‘/’ to the $filename and $artifact variables, so the uri looks something like ‘file:///H:\docs\…’
Otherwise, everything looks pretty cool, thanks.
Danijel
May 9th, 2011 @ 8:36 pm
Danijel,
Thanks for mentioning this to me! I have raised an issue on our issue tracker to investigate this. Oddly enough should a file system URI start with file:// (URI specifier) followed by the path specifier (for example H:\docs\…). The extra slash is unknown to me and I will investigate what is going on.
Mike
June 9th, 2011 @ 12:14 pm
Just a great service you are supplying for those who want to code PHP 5.3 with namespaces. And it looks/works better than phpdocumentor to boot!
One question: on @see comments, is it supposed to link back to class/method? If so, anyone know the correct format? Using:
/**
* @see \Foo\Bar::$property
* @see \Foo\Bar::method()
Thanks again.
June 12th, 2011 @ 10:47 am
Hey Matt!
The @see tag currently does not do anything yet; I hope to implement that in the upcoming month.
The format that you are using is the correct one. This will be used to link to another part of the documentation.
Let me know if you need to know more!
October 17th, 2011 @ 10:18 am
Quality Assurance on PHP projects - PHPDocumentor…
It goes without saying people should document their code so that after a few weeks, months, years they still know what they did initially and why. Besides providing a mental note in the code, it also helps your IDE to figure out what your class is all …
October 18th, 2011 @ 3:45 pm
phpdoc compilers and the @inheritDoc…
I repost some of my blog posts made @ liip. Please see here for the original post and comments: http://blog.liip.ch/archive/2011/07/26/phpdoc-compilers-and-inheritdoc.html In the PHP content repository, we have a set of interfaces and implementation cl…
October 24th, 2011 @ 11:19 am
Quality Assurance on PHP projects - PHPDocumentor feedback…
First of all, thank you all for the enormous feedback I got on my latest article on documentation of code. I got a lot of comments on the usage of PHPDocumentor for the following reasons:…