arduino-libraries / ArduinoBearSSL

Port of BearSSL to Arduino
MIT License
86 stars 49 forks source link

fixed and cleaned documentation links #9

Closed rsora closed 6 years ago

rsora commented 6 years ago

Fixes documentation links as per #3 :

q2dg commented 6 years ago

But this "solution" simply consists in removing the link to the (inexistent) reference. But reference itself doesn't exists yet!

SimonePDA commented 6 years ago

Dear @q2dg we have decided that libraries that are helpers or internal will not be documented on the standard reference pages (this is why the link was removed) to keep the users focused on what matters and to avoid the dispersion of our resources. People interested in such internal information can find it inside the library files themselves as we still document the code with all the relevant information and that will be the reference for such kind of libraries. We have made this choice to allow us to produce the reference documentation online for the fast growing number of libraries that are needed to use the new boards and shields. If you need information on a library as this one, you are capable of getting it from the comments in the code. Thank you for your understanding

Simone

bvernham commented 2 years ago

When is the code going to be documented?