Closed Clovel closed 4 years ago
This adds Doxygen & Dot to the dependencies and adding sudo apt install doxygen graphviz
in the Dockerfile.
I generated the Doxygen, and it already looks good (#39).
@Clovel I have been meaning to do that too specifically for PAL APIs but haven't had time. Thanks for looking into it. Have you evaluated other document generators like Sphinx?
@Clovel I have been meaning to do that too specifically for PAL APIs but haven't had time. Thanks for looking into it. Have you evaluated other document generators like Sphinx?
You're welcome. I'm am not familiar with the other generators, as Doxygen is basically the standard for C/C++ where I work.
Plus with graphviz and a little tinkering you can get great dependency graphs. I don't know if the others do that too.
Just by looking at this comparision, I have the feeling that Doxygen is better. It doesn't need another Makefile
.
Do we want/need a Doxygen documentation generation for this project ? Wouldn't it be a good idea to have one ? There are already lots of documentation comments in the code that could be used by Doxygen.