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.
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: