1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Add doxygen for custom constructor added in e197d657

This commit is contained in:
Angus Gratton 2014-07-03 17:44:30 +10:00
parent e197d65702
commit 1d490dfbf8

View File

@ -127,6 +127,22 @@
* \endcode
*/
/**
* \fn LCD(uint8_t rs, uint8_t enable, uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3)
* \brief Initialize the Freetronics LCD display with custom pins.
*
* For compatibility with other shields, it may be desirable to rewire
* some of the pins entirely. This version of the constructor allows any
* pins to be reassigned from the defaults (which are rs = 8, enable = 9,
* d0 = 4, d1 = 5, d2 = 6, d3 = 7.)
*
* \code
* LCD lcd(8,9,4,5,10,11);
* \endcode
*/
void LCD::init()
{
// The Freetronics display is 16x2.