Commit Graph

14 Commits

Author SHA1 Message Date
Thierry Crozat
5000a24d72 AGS: Move AGS Engine doxygen group definition to ags.h 2021-05-21 20:02:09 +01:00
Thierry Crozat
6acd1ec59e AGS: Improve globals documentation 2021-05-21 19:52:03 +01:00
Orgad Shaneh
a05e54f00c JANITORIAL: Remove trailing whitespaces 2021-05-04 11:46: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
f04056519a DOXYGEN: Review of high prio headers from engines
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.
2020-12-02 00:13:49 +00:00
Bartosz Gentkowski
d082a4837f DOXYGEN: Review headers from 'audio'
This PR has 3 headers in scope of GSoD.
The files are:
- audiostream.h
- mixer.h
- timestamp.h

The rest of the files are only receiving a doxy group.
2020-12-01 23:54:42 +00:00
Bartosz Gentkowski
529b64d8cd DOXYGEN: Review of high prio files from graphics
Editing doxygen comments in:

- cursorman.h
- font.h
- managed_surface.h
- pixelformat.h
- surface.h
2020-12-01 23:24:37 +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
be39e3b4d2 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 23:04:01 +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
Matthew Duggan
5135f1f4b9 ALL: Run optipng to reduce png file size 2020-11-01 21:34:03 +09: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