- 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@3cd6417cdfafba340145939c2054ec614e1bd33e
as included below:
Infer the name of NetMsgStr and NetMsgHotKey from the
PSX debug names of:
char *PanBtnHotKey[8];
unsigned long PanBtnStr[8];
Note, the previous use of spsz hungarian notation has been removed
since searching for "spsz" gave no results in the merged output of
PSX debug info: https://github.com/diasurgical/scalpel/tree/master/psx/_dump_/_dump_merge_c_
Also simplify if conditions to make
use of boolean values.
(If the cleanup4 PR ends up increasing
inserts/deletions, then this commit is
probably at fault.)
Anders Jenbo
qndel
galaxyhaxz
Robin Eklind