Automatic documentation generation

[gabs1234]

Readily available well-documented open-source documentation tools

• Doxygen
• Sphinx

Doxygen seems to more be widespread and have a better documetation. This could help us easily exhibit our public functions that should be used by the user and how they relate to the super class (which functions are overrided, which member variables are public, etc).
May also enable automatic UML style class-inheritance diagrams.

Work that would need to be done

Classes and their methods would need to have a commented header documenting the said-functions. A standard syntax would have to followed. Fortunately, this is already mostly done.

[gabs1234]

Actually this is ideal:
https://gitlab.gnome.org/GNOME/gi-docgen

Doxygen is nice if you're doing some vanilla C or some C++. With GLib/GObject it doesn't fair so well (not out-of-the-box at least)