Skip to content

Commit 0b4372d

Browse files
authored
Merge pull request #507 from per1234/settimeout-functions
Document functions affected by setTimeout()
2 parents 6f0300d + eead475 commit 0b4372d

File tree

2 files changed

+48
-2
lines changed

2 files changed

+48
-2
lines changed

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

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

1515
[float]
1616
=== Description
17-
`Serial.setTimeout()` sets the maximum milliseconds to wait for serial data when using link:../readbytesuntil[serial.readBytesUntil()] or link:../readbytes[serial.readBytes()]. It defaults to 1000 milliseconds.
17+
`Serial.setTimeout()` sets the maximum milliseconds to wait for serial data. It defaults to 1000 milliseconds.
1818

1919
`Serial.setTimeout()` inherits from the link:../../stream[Stream] utility class.
2020
[%hardbreaks]
@@ -37,6 +37,29 @@ Nothing
3737
// OVERVIEW SECTION ENDS
3838

3939

40+
// HOW TO USE SECTION STARTS
41+
[#howtouse]
42+
--
43+
44+
[float]
45+
=== Notes and Warnings
46+
Serial functions that use the timeout value set via `_Serial_.setTimeout()`:
47+
48+
* `_Serial_.find()`
49+
* `_Serial_.findUntil()`
50+
* `_Serial_.parseInt()`
51+
* `_Serial_.parseFloat()`
52+
* `_Serial_.readBytes()`
53+
* `_Serial_.readBytesUntil()`
54+
* `_Serial_.readString()`
55+
* `_Serial_.readStringUntil()`
56+
57+
[%hardbreaks]
58+
59+
--
60+
// HOW TO USE SECTION ENDS
61+
62+
4063
// SEE ALSO SECTION
4164
[#see_also]
4265
--

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

+24-1
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,27 @@ title: Stream.setTimeout()
3333
Nothing
3434

3535
--
36-
// OVERVIEW SECTION ENDS
36+
// OVERVIEW SECTION ENDS
37+
38+
39+
// HOW TO USE SECTION STARTS
40+
[#howtouse]
41+
--
42+
43+
[float]
44+
=== Notes and Warnings
45+
Stream functions that use the timeout value set via `setTimeout()`:
46+
47+
* `find()`
48+
* `findUntil()`
49+
* `parseInt()`
50+
* `parseFloat()`
51+
* `readBytes()`
52+
* `readBytesUntil()`
53+
* `readString()`
54+
* `readStringUntil()`
55+
56+
[%hardbreaks]
57+
58+
--
59+
// HOW TO USE SECTION ENDS

0 commit comments

Comments
 (0)