Skip to content

Consistently document inheritance from Stream class #510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Language/Functions/Communication/Serial/available.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ title: Serial.available()

[float]
=== Description
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.
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).

`Serial.available()` inherits from the link:../../stream[Stream] utility class.
[%hardbreaks]


Expand Down
4 changes: 3 additions & 1 deletion Language/Functions/Communication/Serial/parseInt.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ title: Serial.parseInt()

[float]
=== Description
Looks for the next valid integer in the incoming serial `stream.parseInt()` inherits from the link:../../stream[Stream] utility class.
Looks for the next valid integer in the incoming serial.

`Serial.parseInt()` inherits from the link:../../stream[Stream] utility class.


In particular:
Expand Down
4 changes: 3 additions & 1 deletion Language/Functions/Communication/Serial/peek.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ title: Serial.peek()

[float]
=== Description
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.
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()`.

`Serial.peek()` inherits from the link:../../stream[Stream] utility class.
[%hardbreaks]


Expand Down
4 changes: 3 additions & 1 deletion Language/Functions/Communication/Serial/read.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ title: Serial.read()

[float]
=== Description
Reads incoming serial data. read() inherits from the link:../../stream[Stream] utility class.
Reads incoming serial data.

`Serial.read()` inherits from the link:../../stream[Stream] utility class.
[%hardbreaks]


Expand Down
3 changes: 1 addition & 2 deletions Language/Functions/Communication/Serial/readString.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ title: Serial.readString()
=== Description
`Serial.readString()` reads characters from the serial buffer into a String. The function terminates if it times out (see link:../settimeout[setTimeout()]).

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.

`Serial.readString()` inherits from the link:../../stream[Stream] utility class.
[%hardbreaks]


Expand Down
3 changes: 1 addition & 2 deletions Language/Functions/Communication/Serial/readStringUntil.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ title: Serial.readStringUntil()
=== Description
`readStringUntil()` reads characters from the serial buffer into a String. The function terminates if it times out (see link:../settimeout[setTimeout()]).

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.

`Serial.readStringUntil()` inherits from the link:../../stream[Stream] utility class.
[%hardbreaks]


Expand Down