Fixing serial buffer docs (#600)

* Fixing serial buffer docs

* updated shims
This commit is contained in:
Peli de Halleux
2017-12-11 00:37:57 -08:00
committed by GitHub
parent ac78b0c95a
commit 26680823ff
4 changed files with 12 additions and 5 deletions

View File

@ -412,7 +412,7 @@
"serial.delimiters": "Returns the delimiter corresponding string",
"serial.onDataReceived": "Registers an event to be fired when one of the delimiter is matched.",
"serial.onDataReceived|param|delimiters": "the characters to match received characters against.",
"serial.readBuffer": "Reads multiple characters from the receive buffer and fills a user buffer.",
"serial.readBuffer": "Reads multiple characters from the receive buffer. Pauses until enough characters are present.",
"serial.readBuffer|param|length": "default buffer length, eg: 64",
"serial.readLine": "Reads a line of text from the serial port.",
"serial.readString": "Reads the buffered received data as a string",