2007/6/25, Anders Olofsson <[EMAIL PROTECTED]>:
Apparently there were more than just /** or /// to choose between for the documentation. I'd prefer to use the javadoc style as I'm used to that and already started using it in the qt4-gui. Example:
Fine by me.
* The @brief isn't necessary from what I've read. By default the first sentence or line will be used and there is no need for an empty line between the brief and the longer description.
I think I had some reason for using @brief, but I can't remember it now so it can't have been of any greater importance :)
Also after reading "Before committing, generate the doxygen documentation and check it to make sure it's sane." I think it should say how to generate it. Or if there is something that could be added to the makefiles to make it easy to generate, do that.
In the erijo-dev branch it's as simple as make doxy. This is also how it will work in newapi unless someone else thinks otherwise. // Erik -- Erik Johansson http://ejohansson.se/
