- 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)
Now diablo.h is treated in the same way as all other header files of
Source, as it only contains the declarations of global variables and
functions of diablo.cpp.
Besides consistency, this also enables mods to include diablo.h just
like any other header file without having to include every header file
(and without having to include C++ specific aspects of the now all.h).
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.
This is to avoid confusion, as pCelBuff is also
commonly used as a parameter name.
The naming follows the convention used by
TextBox2.CEL and TextSlid.CEL, as seen in
stores.cpp
pSTextBoxCels = LoadFileInMem("Data\\TextBox2.CEL", NULL);
pSPentSpn2Cels = LoadFileInMem("Data\\PentSpn2.CEL", NULL);
pSTextSlidCels = LoadFileInMem("Data\\TextSlid.CEL", NULL);
Anders Jenbo
galaxyhaxz
qndel
Marco
Gleb Mazovetskiy
falquinho
Robin Eklind
Duarte Alvim