Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
DOXYGEN: Add doxygen groups to header files in the common folder #2361
You can find the current doxygen config file in https://github.com/scummvm/scummvm-sites/tree/doxygen
And indeed there is a lot of work needed to organise our doxygen documentation and make it usable. This looks like a good start. Using groups is a good idea and the main page could for example be improved with some basic information and link to https://wiki.scummvm.org/index.php?title=Developer_Central.
I wasn't aware of the scummvm-sites fork, thanks :)
Yes, and not only the main page, I bet there is much more 'conceptual' documentation that could be added to the doxygen docset that would explain how the API works. The empty placeholder pages that are there right now that are supposed to explain how to implenent a plugin are an example of this.
Adding @defgroup and @InGroup doxygen tags into all headers in the common folder that contain doxygen blocks. This improves the structure, readability, and findability of information in the resulting output. This commit targets purely structure and does not deal with the content of the currently existing doxygen documentation.
The output is now available for preview on https://b-gent.github.io/PR2361/group__common.html
@sev- , it would be great if you could have a look at the comments here and the PR as a whole.