suikan4github / rpp_driver

An experimental Duplex I2S implementation on PIO and its example applications.
MIT License
0 stars 0 forks source link

Doxygen cannot genearete document. #24

Closed suikan4github closed 1 month ago

suikan4github commented 1 month ago

In v1.0.0, Doxygen cannot generate the document of the rpp_driver::I2cMaster and others.

The root cause of this problem is the new conditional compile which covers the whole i2cmaster.hpp. To overcome it, we should add some new predefined macro. For example, the current implementation of the conditional compile is like this :

https://github.com/suikan4github/rpp_driver/blob/f380e2b3bb627307570cfc471da681ec3f8d8a46/src/i2c/i2cmaster.hpp#L13

We can change it to :

 #if __has_include(<hardware/i2c.h>) || __has_include(<gmock/gmock.h>) || DOXYGEN_COMPILE 

And then, add DOXYGEN_COMPILE macron to the Doxyfile.

suikan4github commented 1 month ago

Ready to release.