search

apple / HomeKitADK

Apache License 2.0
2.55k stars 232 forks source link

Doxygen documentation generation #39

Closed Clovel closed 4 years ago

Clovel commented 4 years ago

This MR is an example of what can be done. We must discuss if we want such documentation generation (#38).

Clovel commented 4 years ago

This MR is an example of what could be done for #38.

Clovel commented 4 years ago

Any news on this @aajain-com ?

Clovel commented 4 years ago

Sorry I haven't take a look but this is next on my things to try. I don't see any where if you are limiting the doc generation to a specific directory or a file. I feel there is less value in generating doc for all of ADK and we should limit it to PAL APIs mostly.

That is possible. I will look into it.

aajain-com commented 4 years ago

Also, https://exhale.readthedocs.io/en/latest/#exhale-version-compatibility-with-python-sphinx-and-breathe seems promising.

Sphinx seems to generate much better output than doxygen. I am going to play around with it and let you know how it goes.

Clovel commented 4 years ago

Question of taste I guess.

I really like the dependency graphs of the Doxygen documentation, but its an interesting feature for developers, not users.

If the Sphinx documentation results in webpages like in the link you gave (other example), I like that. It’s a good way to explain the API.

aajain-com commented 4 years ago

I have this working, will send a pull request shortly.

aajain-com commented 4 years ago

Replaced by https://github.com/apple/HomeKitADK/pull/48