Difference between revisions of "SoD Ideas"

Jump to navigation Jump to search
190 bytes added ,  23:59, 3 May 2020
Line 4: Line 4:


== Add more Doxygen comments to OSystem ==
== Add more Doxygen comments to OSystem ==
We use doxygen for documenting ScummVM. Unfortunately, we were not very consistent with describing the newly added methods and classes.
We use doxygen to generate technical documention related to ScummVM. Unfortunately, over the time we were not always very consistent with describing the newly added methods and classes.


Those are the directories to cover:
Those are the directories we cover:
* common/
* common/
* audio/
* audio/
Line 15: Line 15:
* video/
* video/
* engines/*.h (only files in the root directory)
* engines/*.h (only files in the root directory)
The project is to review the current generated documentation and work with the developer on adding enough comments to make it more useful.

Navigation menu