scummvm/doc/doxygen/mainpage.dox

/**

@mainpage ScummVM API reference

These pages contain cross-referenced documentation for the ScummVM source code, generated with @linkDoxygen directly from the source. Currently, not much is properly documented, but at least you can get an overview of almost all the classes, methods, and variables, and how they interact.

*/
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`

			`These pages contain cross-referenced documentation for the ScummVM source code, generated with @linkDoxygen directly from the source. Currently, not much is properly documented, but at least you can get an overview of almost all the classes, methods, and variables, and how they interact.`

			`*/`