This is a doxygen review for 4 header files that have been
identified as high priority for GSoD:
- advancedDetector.h
- metaengine.h
- engine.h
- util.h
It also adds doxy groups to other headers from this folder to
make them appear properly in the structure.
There is only one file in this folder that is in scope of
GSoD - image_decoder.h. It was in great shape docwise though,
so not much review required.
The rest of the headers have received a doxy group definition.
The output directory is not defined by the DOXYGEN_OUTPUT_DIRECTORY
environment variable instead of being hardcoded to `html`. Both the
make rule and the bash script set that variable to `html` by default,
but in the case of the bash script we can override it by defining
the variable in the environement before running the script.
This commit adds the doxygen build framework to the main
scummvm repo.
This allows to easily build and test API doc when making any
kind of changes in doxygen blocks in header files.
The build can be run from command line in the 'doxygen'
folder with 'doxygen scummvm.doxyfile'.
Output is produced in the 'html' folder and can be viewed
by opening the 'index.html' file.
The 'buildfiles' folder contains files related to style.
The output uses the vanila doxygen skin.
