openAVproductions / openAV-Luppp

Luppp is a live performance tool, created by OpenAV productions.
http://openavproductions.com/luppp
GNU General Public License v3.0
258 stars 44 forks source link

Add Doxygen configuration #215

Closed coderkun closed 6 years ago

coderkun commented 6 years ago

Based on @georgkrause’s Doxygen configuration this PR introduces a configuration file for Doxygen which generates a documentation in the folder ´doc´ and docstrings for some/many/all classes and methods (see #214).

To generate the documentation, simply run

$ doxygen Doxyfile
georgkrause commented 6 years ago

Works fine here. No we need some docstrings. Lets talk on IRC tomorrow, i would like to start on some midi stuff because i want to spend some time there.

georgkrause commented 6 years ago

lets merge this and add comments in new PRs

harryhaaren commented 6 years ago

@coderkun were the defaults of Doxygen used, or any particular config options changed? Anything special? Reviewing 2000+ lines isn't a good use of time :)

georgkrause commented 6 years ago

i generated it. I used a config which generates a lot of useful graphs (at least from my point of view).

I used it in the first place to get the connections of the different parts of luppp without clicking through a lot if files.

Downside is, that it takes some time to compile.

georgkrause commented 6 years ago

In detail, i checked:

coderkun commented 6 years ago

Baset on @georgkrause, I set the README.md file as “main” file so that we have a nice description as start page of the documentation.

Thanks for merging!