thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
scummvm/doc/doxygen/mainpage.dox

10 lines
254 B
Text
Raw Permalink Normal View History

DOXYGEN: Add doxygen build files 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.
2020-09-12 01:29:37 +02:00
/**
@mainpage ScummVM API reference
DOXYGEN: Fix the build output and structure This commit introduces a couple tweaks to the doxygen build configuration to assure the overall structure looks correct.
2020-12-02 21:14:24 +01:00
These pages contain cross-referenced documentation for the ScummVM source code, generated with @linkDoxygen directly from the source.
Currently, not everything is properly documented but it is work in progress.
DOXYGEN: Add doxygen build files 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.
2020-09-12 01:29:37 +02:00
*/
Reference in a new issue Copy permalink