Skip to content

Commit 0f9bb8e

Browse files
authored
Merge pull request #510 from per1234/consistent-stream-class-inheritance-documentation
Consistently document inheritance from Stream class
2 parents 3399b1c + 12ef745 commit 0f9bb8e

File tree

6 files changed

+14
-8
lines changed

6 files changed

+14
-8
lines changed

Language/Functions/Communication/Serial/available.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ title: Serial.available()
1111

1212
[float]
1313
=== Description
14-
Get the number of bytes (characters) available for reading from the serial port. This is data that's already arrived and stored in the serial receive buffer (which holds 64 bytes). `available()` inherits from the Stream utility class.
14+
Get the number of bytes (characters) available for reading from the serial port. This is data that's already arrived and stored in the serial receive buffer (which holds 64 bytes).
15+
16+
`Serial.available()` inherits from the link:../../stream[Stream] utility class.
1517
[%hardbreaks]
1618

1719

Language/Functions/Communication/Serial/parseInt.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ title: Serial.parseInt()
1414

1515
[float]
1616
=== Description
17-
Looks for the next valid integer in the incoming serial `stream.parseInt()` inherits from the link:../../stream[Stream] utility class.
17+
Looks for the next valid integer in the incoming serial.
18+
19+
`Serial.parseInt()` inherits from the link:../../stream[Stream] utility class.
1820

1921

2022
In particular:

Language/Functions/Communication/Serial/peek.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ title: Serial.peek()
1414

1515
[float]
1616
=== Description
17-
Returns the next byte (character) of incoming serial data without removing it from the internal serial buffer. That is, successive calls to `peek()` will return the same character, as will the next call to `read()`. `peek()` inherits from the link:../../stream[Stream] utility class.
17+
Returns the next byte (character) of incoming serial data without removing it from the internal serial buffer. That is, successive calls to `peek()` will return the same character, as will the next call to `read()`.
18+
19+
`Serial.peek()` inherits from the link:../../stream[Stream] utility class.
1820
[%hardbreaks]
1921

2022

Language/Functions/Communication/Serial/read.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ title: Serial.read()
1414

1515
[float]
1616
=== Description
17-
Reads incoming serial data. read() inherits from the link:../../stream[Stream] utility class.
17+
Reads incoming serial data.
18+
19+
`Serial.read()` inherits from the link:../../stream[Stream] utility class.
1820
[%hardbreaks]
1921

2022

Language/Functions/Communication/Serial/readString.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ title: Serial.readString()
1616
=== Description
1717
`Serial.readString()` reads characters from the serial buffer into a String. The function terminates if it times out (see link:../settimeout[setTimeout()]).
1818

19-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
20-
19+
`Serial.readString()` inherits from the link:../../stream[Stream] utility class.
2120
[%hardbreaks]
2221

2322

Language/Functions/Communication/Serial/readStringUntil.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ title: Serial.readStringUntil()
1616
=== Description
1717
`readStringUntil()` reads characters from the serial buffer into a String. The function terminates if it times out (see link:../settimeout[setTimeout()]).
1818

19-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
20-
19+
`Serial.readStringUntil()` inherits from the link:../../stream[Stream] utility class.
2120
[%hardbreaks]
2221

2322

0 commit comments

Comments
 (0)