search

apple / HomeKitADK

Apache License 2.0
2.55k stars 232 forks source link

Doxygen documentation ? #38

Closed Clovel closed 4 years ago

Clovel commented 4 years ago

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.

Clovel commented 4 years ago

This adds Doxygen & Dot to the dependencies and adding sudo apt install doxygen graphviz in the Dockerfile.

Clovel commented 4 years ago

I generated the Doxygen, and it already looks good (#39).

aajain-com commented 4 years ago

@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 commented 4 years ago

@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.

Clovel commented 4 years ago

Just by looking at this comparision, I have the feeling that Doxygen is better. It doesn't need another Makefile.