- Add file documentation to about 1/4 of the files in Source
- Copy over a lot of the documentation from the sanctuary/notes repo
- Standardise all the existing documentation
- Create a configuration for Doxygen
- Add more documentation (engine.cpp is now fully documented)
Rationale described in sanctuary/notes@541e63f85a442cbb2293734c24c5868ccceec800
as included below:
Note, the ChrBtnsRect global doesn't have PSX debug info.
However, the functionality correspond to that of InvRect
of inv.h. Moreover, the we may infer the name from the
function CheckChrBtns, and simply combine the two names.
* Clean up MAI_Golum
* Clean up MAI_Garbud
* Clean up MAI_Lachdanan
* Clean up DeleteMonsterList
* Clean up FreeMonsters
* Define enums for resistance
* Correct AddPanelString input
* Correct pinfoflag type
* Define monster_goal
* apply enum to _pIFlags
* Correct DeleteMonsterList
* Add TODO for possible bug fix.
* Clean up ToggleSpell
* Clean up DrawLifeFlask and UpdateLifeFlask
* Clean up DrawManaFlaskm, control_update_life_mana and UpdateManaFlask
* Clean up CheckSBook
* Clean up DoSpeedBook
* Decompose magic numbers
* Clean up GetSBookTrans
* Apply spell_type
* Slight clean up of DrawSpellList
This improves the bin diff a little bit but more importantly gets rid of
_p*Spells[] usage in control.cpp
galaxyhaxz
Anders Jenbo
qndel
Robin Eklind
Andrew Dunstan