scummvm/doc/doxygen/groups.dox

/**

@defgroup common Common API
@brief Common functions and structures.

*/

/**

@defgroup lua Lua API
@ingroup common
@brief Functions for the Lua programming language. See @linkLua.

*/

/**

@defgroup graphics Graphics API
@brief API related to on-screen graphics - surfaces, pixels, cursors, fonts, palettes, and renderers.

*/

/**

@defgroup image Image API
@brief API of various image decoders used in engines.

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

			`@defgroup common Common API`
			`@brief Common functions and structures.`

			`*/`

			`/**`

			`@defgroup lua Lua API`
			`@ingroup common`
			`@brief Functions for the Lua programming language. See @linkLua.`

DOXYGEN: Doxy work on files from 'image' 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. 2020-11-29 21:41:07 +01:00			`*/`

			`/**`

DOXYGEN: Review of high prio files from graphics Editing doxygen comments in: - cursorman.h - font.h - managed_surface.h - pixelformat.h - surface.h 2020-11-25 01:52:40 +01:00			`@defgroup graphics Graphics API`
			`@brief API related to on-screen graphics - surfaces, pixels, cursors, fonts, palettes, and renderers.`

			`*/`

			`/**`

DOXYGEN: Doxy work on files from 'image' 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. 2020-11-29 21:41:07 +01:00			`@defgroup image Image API`
			`@brief API of various image decoders used in engines.`

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