adafruit / Adafruit_VL53L0X

Arduino library for Adafruit VL53L0X
149 stars 118 forks source link

Doxygen index page is blank #35

Closed evaherrada closed 4 years ago

siddacious commented 4 years ago

After taking a look, this will likely require a change to the Doxygen config because all the code is within src/

evaherrada commented 4 years ago

@siddacious how would you reccomend I go about doing this? Do you think we should have the master Doxyfile check in src/ in addition to where it's already checking or should we have this repository and any others that have src/ their own special Doxyfile?

siddacious commented 4 years ago

TBH I'm not sure if it would make sense to flatten the code a bit and pull our code out of src/ and into the root, or changing the Doxyfile. I'm not familiar enough with the expected or permissible layouts, but from my experience src/ are uncommon.

@ladyada any input?

ladyada commented 4 years ago

you could try to move the .cpp/.h files down to root level - i'd do that in a branch to verify everything still compiles, and use git mv so you dont lose history

evaherrada commented 4 years ago

@ladyada would that break libraries that have this as a dependency? I'd assume it wouldn't be too hard to get it to compile if there's any issues, but would other libraries that use it do #include <src/X>?

ladyada commented 4 years ago

no, but you may have to adjust the #include's for the new paths

evaherrada commented 4 years ago

Ok