DocBlox

PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration

Release of v0.13.3

Posted on | August 21, 2011 | 1 Comment

It would appear I have forgotten to write a blog post after the release of v0.13.2 and v0.13.1. Bit of a shame.. So together with v0.13.3 I am posting the fixes and enhancements of the past two bug fix releases as well!
Read more

Release of v0.13.0

Posted on | August 8, 2011 | No Comments

One day later than planned but this is an awesome release to do! 0.13.0 brings several improvements related to inheritance of items (thus seeing your parent’s method in a child class) and not to say the least an overhaul of the Class view!

Read more

Release of v0.12.3

Posted on | August 5, 2011 | No Comments

Starting with this revision I will also be writing a change summary for every minor that is released. This will mean shorter summaries as they will be spread out but I hope that you will forgive me for that ;)

Read more

Release of v0.12.0

Posted on | July 17, 2011 | 2 Comments

As announced last month is release 0.12.0 of DocBlox here. I had intended to finish restructuring the application and then implement the Plugin architecture but this is taking more effort then I could manage in one month of work combined with working on existing feature requests. Despite this, DocBlox has an great set of new features and changes!

Read more

Release of v0.11.0

Posted on | June 12, 2011 | 6 Comments

A lot has happened in the past month, not all of which in the code.

Unfortunately we also had to postpone this release with one week as a critical bug arose which affected any file which was larger than 50.000 lines of code (also known as 50 KLOC). Please don’t get me wrong: if you have such a file, you should sincerely consider refactoring that but reality tells us that these things happen and I am convinced that DocBlox should support it!

Dutch PHP Conference

DocBlox was also featured in the Unconference of the Dutch PHP Conference 2011 in the talks ‘Inside DocBlox’ by Mike van Riel and ‘Phing – a PHP build tool – short introduction’ by Michiel Rook (thanks!).

Improvements

The conference and planning of that talk took some of the velocity away from the Project but nonetheless I can announce some great new stuff:

  • DocBlock Data Inheritance; classes, properties and methods are now able to inherit a short description, long description and a selection of tags from its parent
  • A new task ‘theme:list’ to see which themes are supported by default
  • A new task ‘theme:generate’ to create a theme skeleton upon which you can build your own branding
  • Added argument –visibility, this allows you to limit which methods are actually included (public, protected, private, all)
  • Colour coding of methods and properties to indicate whether they are public, protected or private has been added
  • Improved support for different character encodings
  • Improved ignore to support multiple source directories (as long as those are on the same partition)
  • Parser performance is improved
  • Empty PHP files caused an error; this has been fixed

The items mentioned here are only an excerpt from what was done in the past month. As always; if you want to see a full list of changes please read the CHANGELOG in the docs folder.

Plugins

What was not mentioned is that work has begun to add plugins to DocBlox. Initially they would allow you to inject custom functionality for specific tags but in a later stage this may add even more things that you can extend DocBlox with. Next month will be a new update on this.

Upcoming talks

If you’d like to have a introduction talk into DocBlox and life in or near the Netherlands then please visit pfCongres 2011 where I will be giving an introductory talk on documenting with DocBlox!

Conclusion

As you can see, lots of good stuff has been done and is still coming! Also: keep an eye out on the documentation, things might be changing there real soon?

Next release will be in the weekend of 18 and 19 July (my schedule does not permit an earlier release). After that we will return to release every first weekend of the month. Please follow the @DocBlox account on twitter to receive the latest information.

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:

  1. A brand new shining spunky super-duper-delicious template! (At least; we think so ;) )
  2. The Class Inheritance Diagram now supports panning and zooming
  3. The sidebar now also shows:
    1. A list of files and their contents
    2. The functions contained in a package or namespace
    3. 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!
  4. Support for the @link tag
  5. A completely re-vamped Task Runner
  6. PEAR package no longer includes the dependencies but has a link to the required PEAR packages.
  7. 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!

Release of v0.9.0

Posted on | April 2, 2011 | No Comments

On February 1st I had announced this project to the world and DocBlox was at version 0.7.1 at that time.

Since that time this website has been created; the project is now followed by more than 100 people on Github, we have had dozens of commits and released version 0.8.3. Another milestone that we have reached in the mean time is that both Aura Framework (successor to Solar) and PPI Framework have chosen to adopt DocBlox as the tool to generate their API documentation with.

Now, I am proud to say that the Beta version 0.9.0 has been released on Github and on PEAR. A lot has changed; a lot of issues resolved and new features were built since version 0.8.3.
A complete list of changes, fixes and additions can be found in the CHANGELOG file located in the docs folder but I will try to summarize the things that stand out the most:

Read more

DocBlox has its own domain, and more!

Posted on | February 26, 2011 | 2 Comments

The DocBlox project has really taken off since my introduction post. The interest in the project has sparked and quite a bit of changes have been pushed onto Github.

With this interest comes the challenge of taking your project to the next level; in my case that meant I had to introduce communication paths, documentation, and a better process control.

Read more

« go back
  • About DocBlox

    DocBlox has merged with phpDocumentor to become phpDocumentor2. Please come visit http;//www.phpdoc.org
  • Admin