Difference between revisions of "SoD Ideas"

From ScummVM :: Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
== Update User Manual ==
 
== 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.
+
[[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 ==
 
== 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 for documenting ScummVM. Unfortunately, we were not very consistent with describing the newly added methods and classes.
  
Directories to cover:
+
Those are the directories to cover:
 
 
 
* common/
 
* common/
 
* audio/
 
* audio/

Revision as of 23:40, 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 for documenting ScummVM. Unfortunately, we were not very consistent with describing the newly added methods and classes.

Those are the directories to cover:

  • common/
  • audio/
  • backends/
  • graphics/
  • gui/
  • image/
  • video/
  • engines/*.h (only files in the root directory)