Use doxygen to document QLever?

[dpriskorn]

https://www.doxygen.nl/index.html

[joka921]

We are already working on commenting any new and updated code in the Doxygen format. At some point it would probably be nice to actually generate the docu, especially if people are interested in contributing to the QLever codebase (See also my Email from today).

[hannahbast]

It's trivial for anyone to generate that documentation theirselves: just checkout the code and run doxygen.

I am not sure how useful that is though. The code is already on GitHub, where you can look at it with nice syntax highlighting. Doxygen offers little added value on top of that.

What would be of very significant added value is a document that describes the overall design of QLever, with a good overview over which components there are, the principle ideas behind them, and how and where they are implemented in the code. As I said, I will start writing that document soon.

[dpriskorn]

Class hierarchy is one thing it can generate. That way you can get a high level overview of the classes.

[hannahbast]

@dpriskorn Not really useful in my experience without an accompanying document explaining it. Especially not for a very large project with very many classes

[hannahbast]

Interesting discussion, but not an open issue anymore.