The last two weeks have seen a flurry of activity for building out our documentation site. This includes API Documentation, examples and user generated documentation.
I hope our documentation solution provides a wealth of useful information and allows the qcubed community to participate and help others learn.
The latest details regarding the progress can always be found here: http://trac.qcu.be/projects/qcubed/wiki/ApiDocumentation
Some Highlights:
- Since the qcu.be site is built on drupal, we are going to store all of the API documentation within drupal.
- The documentation will be generated directly from the source code with doxygen.
- Comments are to be placed in the source code using doxygen formatting rules. There will be examples of best practices on how to document various pieces of the code base.
- Internationalization will be possible using a drupal module for translating content.
There is still a bit of work to do to integrate the documentation system into a cohesive architecture that is both useful and maintainable. A release date has not been set, though significant progress is being made.
Rodney
