Doxygen style comments

TA Spring has automatically generated documentation for the source code which can be found here. The tool used for this is doxygen. Whilst doxygen does a good job of producing diagrams and extracting logical relationships from the code, the documentation can be somewhat hard to digest without any descriptive text to read!

Therefore, please put doxygen style comments into the code, which makes it all the nicer both when reading the code and also when reading the documentation. It's the same syntax as Javadoc basically. If you're not familiar with that, the main thing you need to know is to use:

/**

At the start of your comment blocks (it also works with /*!). Or on the otherhand if you prefer using // style comments, use /// (or //! if you prefer).

Within the comment blocks you can also use special commands including the very useful @todo command. All @todo commands are noted by Doxygen and pulled out into a single "TODO" list page, which lists all the @todo items across the entire project in one place.

The full doxygen manual describes all the various commenting conventions you can use which doxygen will pick up. This includes nice things like being able to mark several items as having the same comment, producing lists, links into other classes/methods, how to use HTML within comments etc.

The current codebase (0.65b2) does contain non doxygen comments as we've only just started using it. If you do see header/field comments which start with just /* or //, please do a search-and-replace on them so that we can have the benefit of them in the documentation. Thanks