0

Where are library docs?
Moderators: adafruit_support_bill, adafruit

Please be positive and constructive with your questions and comments.

Where are library docs?

by DonKrapf on Thu Aug 15, 2019 1:17 pm

Adafruit produces a lot of fine libraries for its products. Where is the library documentation? Don't you use doxygen to produce automated docs directly from the sources? Should I run it locally?

Specifically, I'm using the RA8875 driver. I know that the truth is in the code but it would be nice to have method documentation instead of having to scan through the source.

Thanks,

Don

DonKrapf
 
Posts: 14
Joined: Tue Mar 22, 2016 10:23 am

Re: Where are library docs?

by adafruit_support_carter on Thu Aug 15, 2019 2:07 pm

This is a work in progress. All Arduino libraries are getting a sweep that includes adding doxygen.

You can see some of the progress in the gh-pages branch of the repo:
https://github.com/adafruit/Adafruit_RA ... e/gh-pages

[EDIT]
Try here: http://adafruit.github.io/Adafruit_RA8875

adafruit_support_carter
 
Posts: 13216
Joined: Tue Nov 29, 2016 2:45 pm

Re: Where are library docs?

by DonKrapf on Sat Aug 17, 2019 6:07 pm

Thank you Carter. That's good news.

And Thank You for the direct link to the RA8875 docs! :-)

Don

DonKrapf
 
Posts: 14
Joined: Tue Mar 22, 2016 10:23 am

Please be positive and constructive with your questions and comments.