[Scummvm-devel] Doxygen status

[Thierry Crozat]

Hi Matan,

On my site I mostly find the oxygen site to be useful to get a picture of the relationship between the classes (the inheritance and collaboration diagrams you see in the documentation for each class) when I explore a part of the code I am not familiar with. If somebody knows of an alternative to get those (or similar) diagrams I don't have a strong opinion about keeping it alive or not, although I think it could still have values for developers new to the project.

I suspect the version of doxygen used has been changed at  some point, resulting in the current "ugly" look as well. From my experience styling the result is very dependent on the version of oxygen used to generate the documentation, and at work we ended up throwing away our old styles and just using the default one after several successive doxygen version updates. If we do keep it alive I would suggest going the same path. Defining modules would also help organise the documentation. I could try to get some time to look at that, but that will be limited (I just started working again on my aspect ratio correction branch, and I would like to focus primarily on that until it is in a usable state).

Thierry

> On 5 Jan 2019, at 01:08, Matan Bareket <mataniko at gmail.com> wrote:
> 
> Hi team,
> Taking a pass on doxygen, and it seems like it needs a lot of attention. There are multiple doxygen comments that are outdated with either wrong or missing parameters, no modules are defined and as a result our generated docs are honestly quite bad.
> 
> Is anyone finding any value in the generated docs at this day and age? I'd like to propose getting rid of doxygen unless there's a case to keeping it. If you do feel strongly about keeping Doxygen, please let me know why - and if it's so useful would you be able to take updating it as a project?
> 
> 
> 
> 
> _______________________________________________
> Scummvm-devel mailing list
> Scummvm-devel at lists.scummvm.org
> https://lists.scummvm.org/listinfo/scummvm-devel