Commit graph

7 commits

Author SHA1 Message Date
Hubert Maier
1257553b7d JANITORIAL: DOCS: Fix typos 2024-09-16 01:39:30 +03:00
Thierry Crozat
10a81d87cf DOC: Add TTS and TranslationsManager to doxygen doc 2021-03-16 14:10:45 +00:00
Bartosz Gentkowski
7192ec0bb5 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 22:55:41 +00:00
Bartosz Gentkowski
ee8598ba2c DOXYGEN: disable displaying friend classes in output
As discussed with criezy, showing friend classes in
doxygen output is unnecessary.
2020-12-01 23:24:37 +00:00
Bartosz Gentkowski
24e3b6096e DOXYGEN: Doxygen improvements part 3
Editing doxygen comments in files:

- debug.h
- dialogs.h
- encoding.h
- endian.h
- error.h
- events.h
- fft.h
- file.h
- frac.h
- fs.h
- gui_options.h
- hash-ptr.h
- hashmap.h
- huffman.h
- ini-file.h

Plus some small changes in the config file.
2020-11-04 19:42:34 +00:00
Thierry Crozat
fe32ac1423 DOC: Add make rule and bash script to run doxygen
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.
2020-10-05 02:12:48 +01:00
Bartosz Gentkowski
63da4eacb4 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-10-05 01:58:24 +01:00