Documenting an esp32 project with Doxygen/Breathe/Sphinx
Posted: Mon Jun 07, 2021 9:07 am
I've done some basic searching for this and couldn't find an existing answer.
I've joined a team with existing esp32 code and would like to implement automated documentation for it. Doxygen-style comments are in the code already, but there is not a doxygen output set up.
The project uses the esp-idf style cmake commands with idf_component_register etc.
Currently I can only find documentation on how to document the esp-idf repository itself.
It seems like I could adapt the esp-idf documentation tools for the project I'm working on, but I can't find any documentation on this or examples of anyone who's done it. Am I missing something obvious here and can someone give me links to examples of an implementation?
I've joined a team with existing esp32 code and would like to implement automated documentation for it. Doxygen-style comments are in the code already, but there is not a doxygen output set up.
The project uses the esp-idf style cmake commands with idf_component_register etc.
Currently I can only find documentation on how to document the esp-idf repository itself.
It seems like I could adapt the esp-idf documentation tools for the project I'm working on, but I can't find any documentation on this or examples of anyone who's done it. Am I missing something obvious here and can someone give me links to examples of an implementation?