Difference between revisions of "SoD Ideas"
Jump to navigation
Jump to search
Strangerke (talk | contribs) |
Strangerke (talk | contribs) |
||
| Line 4: | Line 4: | ||
== Add more Doxygen comments to OSystem == | == Add more Doxygen comments to OSystem == | ||
We use doxygen | 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 | 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. | |||
Revision as of 23:59, 3 May 2020
Update User Manual
User Manual for ScummVM was created in 2007 and was not significantly updated since. Many new features got added and existing pages would need to be improved and updated. The purpose of this task would be to refresh the User Manual. It will require to collaborate with the developers who provide technical information as well as user experience.
Add more Doxygen comments to OSystem
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 we cover:
- common/
- audio/
- backends/
- graphics/
- gui/
- image/
- video/
- 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.