From 28b666fb11411c39789e0adf83809c8b67169f6b Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 8 Nov 2017 22:26:17 -0800 Subject: [PATCH] Correct Serial return types References: - https://github.com/arduino/ArduinoCore-avr/blob/3f63f2975e7183c3254b6794bfcc8f19ca0301c9/cores/arduino/HardwareSerial.h - https://github.com/arduino/ArduinoCore-avr/blob/3f63f2975e7183c3254b6794bfcc8f19ca0301c9/cores/arduino/Print.h - https://github.com/arduino/ArduinoCore-avr/blob/3f63f2975e7183c3254b6794bfcc8f19ca0301c9/cores/arduino/Stream.h Fixes https://github.com/arduino/Arduino/issues/6659 --- Language/Functions/Communication/Serial/print.adoc | 2 +- Language/Functions/Communication/Serial/println.adoc | 2 +- Language/Functions/Communication/Serial/readBytesUntil.adoc | 2 +- Language/Functions/Communication/Serial/readString.adoc | 2 +- Language/Functions/Communication/Serial/readStringUntil.adoc | 2 +- Language/Functions/Communication/Serial/write.adoc | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Language/Functions/Communication/Serial/print.adoc b/Language/Functions/Communication/Serial/print.adoc index ec3c32347..b717d677c 100644 --- a/Language/Functions/Communication/Serial/print.adoc +++ b/Language/Functions/Communication/Serial/print.adoc @@ -52,7 +52,7 @@ To send a single byte, use link:../write[Serial.write()]. [float] === Returns -`size_t (long)`: `print()` returns the number of bytes written, though reading that number is optional. +`size_t`: `print()` returns the number of bytes written, though reading that number is optional. -- // OVERVIEW SECTION ENDS diff --git a/Language/Functions/Communication/Serial/println.adoc b/Language/Functions/Communication/Serial/println.adoc index 524fa18e8..eff1d1fc9 100644 --- a/Language/Functions/Communication/Serial/println.adoc +++ b/Language/Functions/Communication/Serial/println.adoc @@ -33,7 +33,7 @@ Prints data to the serial port as human-readable ASCII text followed by a carria [float] === Returns -`size_t` (`long`): `println()` returns the number of bytes written, though reading that number is optional +`size_t`: `println()` returns the number of bytes written, though reading that number is optional -- // OVERVIEW SECTION ENDS diff --git a/Language/Functions/Communication/Serial/readBytesUntil.adoc b/Language/Functions/Communication/Serial/readBytesUntil.adoc index 1f0ccc1c6..db59a1aeb 100644 --- a/Language/Functions/Communication/Serial/readBytesUntil.adoc +++ b/Language/Functions/Communication/Serial/readBytesUntil.adoc @@ -38,7 +38,7 @@ Serial.readBytesUntil() reads characters from the serial buffer into an array. T [float] === Returns -`byte` +`size_t` -- // OVERVIEW SECTION ENDS diff --git a/Language/Functions/Communication/Serial/readString.adoc b/Language/Functions/Communication/Serial/readString.adoc index 8744e4e46..0ed5d29f0 100644 --- a/Language/Functions/Communication/Serial/readString.adoc +++ b/Language/Functions/Communication/Serial/readString.adoc @@ -33,7 +33,7 @@ Nothing [float] === Returns -A string read from the serial buffer +A String read from the serial buffer -- // OVERVIEW SECTION ENDS diff --git a/Language/Functions/Communication/Serial/readStringUntil.adoc b/Language/Functions/Communication/Serial/readStringUntil.adoc index 63838bdf5..72d2a909a 100644 --- a/Language/Functions/Communication/Serial/readStringUntil.adoc +++ b/Language/Functions/Communication/Serial/readStringUntil.adoc @@ -33,7 +33,7 @@ This function is part of the Stream class, and is called by any class that inher [float] === Returns -The entire string read from the serial buffer, until the terminator character is detected +The entire String read from the serial buffer, until the terminator character is detected -- // OVERVIEW SECTION ENDS diff --git a/Language/Functions/Communication/Serial/write.adoc b/Language/Functions/Communication/Serial/write.adoc index a5f45b140..59a67e9e1 100644 --- a/Language/Functions/Communication/Serial/write.adoc +++ b/Language/Functions/Communication/Serial/write.adoc @@ -40,7 +40,7 @@ _Arduino Mega also supports:_ [float] === Returns -`byte` +`size_t` `write()` will return the number of bytes written, though reading that number is optional