Can you file a ticket on our github issue tracker for this please. On Wednesday 29 January 2014 15:13:43 [email protected] wrote: > Those are imo needed. > > I often see header files with large classes and not a single comment. Not > even a comment what the class is doing, and almost all public functions are > not documented. I mean, a comment like "This gets x" on a function named > "int get_x() { return x }" is not necessary, but there are many more > complicated examples. > > The same counts for cpp files... most algorithms are not documented well. > Having a comment each few lines would not harm. E.g. when you begin a large > for- or if-loop. > > Imo this should be done: > * Comment your new code enough, otherwise it should be *rejected* by > admins. * Comment on existing code whenever you see something you > understand. * Let's make a doc directory in the root, where cmake (or an > additional Makefile) will build doxygen docs. That way, it gets easy for > the programmer to see existing docs as well as his new ones. And you see > where docs/comments are still missing. > > ---------------------------------------------------------------------------- > -- WatchGuard Dimension instantly turns raw network data into actionable > security intelligence. It gives you real-time visual feedback on key > security issues and trends. Skip the complicated setup - simply import a > virtual appliance and go from zero to informed in seconds. > http://pubads.g.doubleclick.net/gampad/clk?id=123612991&iu=/4140/ostg.clktrk > _______________________________________________ > LMMS-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/lmms-devel
------------------------------------------------------------------------------ WatchGuard Dimension instantly turns raw network data into actionable security intelligence. It gives you real-time visual feedback on key security issues and trends. Skip the complicated setup - simply import a virtual appliance and go from zero to informed in seconds. http://pubads.g.doubleclick.net/gampad/clk?id=123612991&iu=/4140/ostg.clktrk _______________________________________________ LMMS-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/lmms-devel
