Differences

This shows you the differences between two versions of the page.

--- coding-conventions [2011/03/17 13:14] – mikael.ohman
+++ coding-conventions [2011/03/17 13:43] – mikael.ohman
@@ Line 104: / Line 104: @@
 </code>
-Doxygen will inherit documentation from super classes, so do not add comments unless something specific needs to be said for the implementering routine. Be sure to document all variables and return value, even trivial ones, to avoid reporting errors when generating the documentation.
+Again, Doxygen will inherit documentation from super classes, so do not add comments unless something specific needs to be said for the implementing routine. Be sure to document all variables and return value, even trivial ones, to avoid reporting errors when generating the documentation. Currently, OOFEM contains quite a large number of errors in the documentation and a convenient way to list all these errors is to separate the stderr output with the terminal command;
+<code>
+ doxygen doc/refman/doxygen.cfg 2> dox_errors.txt
+</code>
 === Header file layout ===