search

adafruit / Adafruit_AHRS

Arduino library for AHRS (Attitude and Heading Reference System) for Adafruit motion sensors
214 stars 64 forks source link

Add some doxygen documentation #19

Closed ToMe25 closed 3 years ago

ToMe25 commented 3 years ago

This PR adds some doxygen documentation for some methods.

Some things are not documented because i did not know how to/what they do. Also i am aware the documentation isn't great, but its the best i can reasonably do, while not understanding significant parts of the algorithms used.

I do intend to add some documentation to the other fusion algorithms, but i did not know how to handle their current header. Please tell me what to do with that so i can add some documentation to them.

For reasons unknown to me doxygen did not work with the default file, so i had to set INPUT to src. For this reason i added the Doxyfile to the commit.

I also added the html directory to .gitignore.

ToMe25 commented 3 years ago

Why does running doxygen locally tell me i need to document the return type of the NXP begin and update? Its void and thus shouldn't need any documentation. It say this:

src/Adafruit_AHRS_FusionInterface.h:44: warning: return type of member Adafruit_AHRS_FusionInterface::begin is not documented
src/Adafruit_AHRS_FusionInterface.h:62: warning: return type of member Adafruit_AHRS_FusionInterface::update is not documented
ladyada commented 3 years ago

oh shoot ok we see whats up. umm can you remove the Doxyfile?

ToMe25 commented 3 years ago

I can delete it from git(and i just did), but deleting it locally prevents doxygen from running. We will see whether the CI still works with the file removed tho...

ToMe25 commented 3 years ago

OK, i deleted it, but now the CI isn't generating anything either, should i just add the Doxyfile back so it works again?

ladyada commented 3 years ago

yah thats on us. didnt want to stop your PR :)