Link to full documentation missing #444
Description
Today I started working on a new project that uses a chip supported by Neopixel (WS2812B). Working with hardware is totally new to me. I'm trying to figure stuff out as I would normally do with software projects.
In the README I noticed a list of functions, but not a single reference to any further documentation that describes classes or function arguments, etc. Using Google I found the full reference/documentation and I then learned this documentation is generated from comments in the cpp and h files (good).
I eventually was able to find what I was looking for and confirm the documentation I found using Google was for the library I was using. My expectation (and I think also the expectation of others) however was to simply find a link to the docs in the README.
As a person learning how to work with Neopixel, I'd like to have an easy to find reference (link or otherwise) to the full class documentation in the README so that I:
- know there's more documentation than that just a list of functions;
- am given all the resources to understand the examples (from the README and from source) better;
- can rest easy knowing the documentation I'm looking at is from a reliable, first hand source and is specifically about this library.
The reference could be as simple as a link to the online documentation. If there are reservations about this because older versions of the README may eventually refer to the latest version of the docs online, I suggest to include a text that refers to the comments in the cpp and h file. For example: "Adafruit_NeoPixel.cpp contains the full documentation for these functions. Adafruit_NeoPixel.h has a list of predefined variables."
(Note that some useful comments from Adafruit_NeoPixel.h are not rendered in the online documentation btw)