Open main menu

Difference between revisions of "Code Formatting Conventions"

m
Fix a broken link
(Split seperate examples into multiple <syntax> tags, was especially confusing for the for(;;) example.)
m (Fix a broken link)
Line 195: Line 195:
=== Doxygen documentation comments ===
=== Doxygen documentation comments ===


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]).
ScummVM uses the [http://www.doxygen.org/ Doxygen] software to generate HTML documentation for the codebase (available [http://doxygen.scummvm.org 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.
960

edits