Core Library Documentation

mattbaker.digital

New member
Where can I find the official documentation for the core libraries like `HardwareSerial` `Stream` etc. which give full details of their usage, input parameters return values etc. The header or source files don't seem to contain this information.

If this information isn't commonly available, would it be of use to update the files to include, for example, doxygen formatted definitions?

Things like Stream::getReadError return values would be useful. Is it always 1 when using the core library and does this always indicate a timeout?
 
Back
Top