Skip to content

Commit e9759d0

Browse files
authored
Merge pull request #511 from per1234/stream-timeout-functions
Add missing timeout documentation to Stream functions
2 parents 0f9bb8e + 2d8ee84 commit e9759d0

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

Diff for: Language/Functions/Communication/Serial/parseFloat.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: Serial.parseFloat()
1414

1515
[float]
1616
=== Description
17-
`Serial.parseFloat()` returns the first valid floating point number from the Serial buffer. Characters that are not digits (or the minus sign) are skipped. `parseFloat()` is terminated by the first character that is not a floating point number.
17+
`Serial.parseFloat()` returns the first valid floating point number from the Serial buffer. Characters that are not digits (or the minus sign) are skipped. `parseFloat()` is terminated by the first character that is not a floating point number. The function terminates if it times out (see link:../settimeout[Serial.setTimeout()]).
1818

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

Diff for: Language/Functions/Communication/Serial/parseInt.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: Serial.parseInt()
1414

1515
[float]
1616
=== Description
17-
Looks for the next valid integer in the incoming serial.
17+
Looks for the next valid integer in the incoming serial. The function terminates if it times out (see link:../settimeout[Serial.setTimeout()]).
1818

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

Diff for: Language/Functions/Communication/Stream/streamFind.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: Stream.find()
1414

1515
[float]
1616
=== Description
17-
`find()` reads data from the stream until the target is found. The function returns true if target is found, false if timed out.
17+
`find()` reads data from the stream until the target is found. The function returns true if target is found, false if timed out (see ../streamsettimeout[Stream.setTimeout()]).
1818

1919
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[stream class] main page for more information.
2020
[%hardbreaks]

Diff for: Language/Functions/Communication/Stream/streamFindUntil.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: Stream.findUntil()
1414

1515
[float]
1616
=== Description
17-
`findUntil()` reads data from the stream until the target string of given length or terminator string is found.
17+
`findUntil()` reads data from the stream until the target string of given length or terminator string is found, or it times out (see ../streamsettimeout[Stream.setTimeout()]).
1818

1919
The function returns true if target string is found, false if timed out
2020

Diff for: Language/Functions/Communication/Stream/streamParseFloat.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: Stream.parseFloat()
1414

1515
[float]
1616
=== Description
17-
`parseFloat()` returns the first valid floating point number from the current position. Initial characters that are not digits (or the minus sign) are skipped. `parseFloat()` is terminated by the first character that is not a floating point number.
17+
`parseFloat()` returns the first valid floating point number from the current position. Initial characters that are not digits (or the minus sign) are skipped. `parseFloat()` is terminated by the first character that is not a floating point number. The function terminates if it times out (see ../streamsettimeout[Stream.setTimeout()]).
1818

1919
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more informatio
2020
[%hardbreaks]

0 commit comments

Comments
 (0)