Difference between revisions of "Code Formatting Conventions"

Code Formatting Conventions (view source)

49 bytes removed , 20:15, 4 April 2008

1,079

edits

@@ Line 147: / Line 147: @@
 ScummVM uses the [http://www.doxygen.org/ Doxygen] software to generate HTML documentation for the codebase (available [http://scummvm.org/docs/doxygen/html/index.php here]).
-Doxygen supports ''documentation blocks''. These are specially-formatted comments that doxygen prints out in the generated documentation. They are similar in purpose to Java's Javadoc or Python's docstrings.
+Doxygen supports ''documentation blocks''. These are specially-formatted comments that doxygen prints out in the generated documentation. They are similar in purpose to Java's JavaDoc or Python's docstrings.
-There are many ways to mark such comments, but developers are encouraged to use only this method — a C-style comment block starting with two *'s:
+There are many ways to mark such comments, but developers are encouraged to use the JavaDoc style:
   /**