From: Andre K. <and...@gm...> - 2010-11-11 00:10:05
|
I've added some comments to classes I wrote, and added a Doxyfile, so that now you're able to create documentation with Doxygen. There are several styles to write comments for Doxygen, I'd like to use this one: /** * Multi line * comment */ [whatever you want to comment comes here] /// Single line [whatever you want to comment comes here] [whatever you want to comment comes here] ///< Single line If you disagree, tell us, but it would be good to have a common style :) If you write some documentation, please keep in mind that you mustn't have empty lines between your comment and the actual code. So /** * Multi line * comment */ [whatever you want to comment comes here] won't work. I'd be really great if those who wrote some code would add some documentation, because I've looked through some code in the studio and it was pretty hard to understand ;) |