Jump to navigation Jump to search
ScummVM uses the [ Doxygen] software to generate HTML documentation for the codebase (available [ 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 JavaDoc or Python's docstrings.
There are many ways to mark such comments, but developers are encouraged to use only this method — a C-the JavaDoc style comment block starting with two *'s:


Navigation menu