iLCSoft / MarlinReco

GNU General Public License v3.0
4 stars 40 forks source link

[WIP] Update Doxygen documentation for MarlinReco packages #105

Closed dudarboh closed 1 year ago

dudarboh commented 2 years ago

BEGINRELEASENOTES

ENDRELEASENOTES

TODO:

dudarboh commented 2 years ago

Hi @tmadlener,

At this point I would consider this a basic minimal PR. It just adds paths of processors for documentation.

But as you can see from TODO list, there still few things I would like to add, to make it look fancier than just a list of classes. But these would require a bit more changes in many files, so just in case if you won't be happy with those changes we can always come back to this commit in the end.

tmadlener commented 2 years ago

Thanks @dudarboh. I have no particularly strong feelings about the style or the overall organization. I just saw that you have tweaked quite a few doxygen defaults. Do you happen to have the current results of running doxygen on MarlinReco available somewhere? I think it might be easier to look at the result, rather than sifting through doxygen configuration and guessing what it might look like in the end. There was a link in #104 somewhere, is that pointing to the current version? (Doesn't really matter if that PR is part of the output).

dudarboh commented 2 years ago

@tmadlener For debugging purposes, I will host documentation from current PR here: https://www.desy.de/~dudarboh/marlinreco_doc/html/index.html