From eead475fd517ff478b01208dcc1a3265db8531d6 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sun, 3 Feb 2019 04:59:13 -0800 Subject: [PATCH] Document functions affected by setTimeout() --- .../Communication/Serial/setTimeout.adoc | 25 ++++++++++++++++++- .../Stream/streamSetTimeout.adoc | 25 ++++++++++++++++++- 2 files changed, 48 insertions(+), 2 deletions(-) diff --git a/Language/Functions/Communication/Serial/setTimeout.adoc b/Language/Functions/Communication/Serial/setTimeout.adoc index 808817ea7..80c27a70a 100644 --- a/Language/Functions/Communication/Serial/setTimeout.adoc +++ b/Language/Functions/Communication/Serial/setTimeout.adoc @@ -14,7 +14,7 @@ title: Serial.setTimeout() [float] === Description -`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. +`Serial.setTimeout()` sets the maximum milliseconds to wait for serial data. It defaults to 1000 milliseconds. `Serial.setTimeout()` inherits from the link:../../stream[Stream] utility class. [%hardbreaks] @@ -37,6 +37,29 @@ Nothing // OVERVIEW SECTION ENDS +// HOW TO USE SECTION STARTS +[#howtouse] +-- + +[float] +=== Notes and Warnings +Serial functions that use the timeout value set via `_Serial_.setTimeout()`: + +* `_Serial_.find()` +* `_Serial_.findUntil()` +* `_Serial_.parseInt()` +* `_Serial_.parseFloat()` +* `_Serial_.readBytes()` +* `_Serial_.readBytesUntil()` +* `_Serial_.readString()` +* `_Serial_.readStringUntil()` + +[%hardbreaks] + +-- +// HOW TO USE SECTION ENDS + + // SEE ALSO SECTION [#see_also] -- diff --git a/Language/Functions/Communication/Stream/streamSetTimeout.adoc b/Language/Functions/Communication/Stream/streamSetTimeout.adoc index d5772ee23..cc2ae5758 100644 --- a/Language/Functions/Communication/Stream/streamSetTimeout.adoc +++ b/Language/Functions/Communication/Stream/streamSetTimeout.adoc @@ -33,4 +33,27 @@ title: Stream.setTimeout() Nothing -- -// OVERVIEW SECTION ENDS \ No newline at end of file +// OVERVIEW SECTION ENDS + + +// HOW TO USE SECTION STARTS +[#howtouse] +-- + +[float] +=== Notes and Warnings +Stream functions that use the timeout value set via `setTimeout()`: + +* `find()` +* `findUntil()` +* `parseInt()` +* `parseFloat()` +* `readBytes()` +* `readBytesUntil()` +* `readString()` +* `readStringUntil()` + +[%hardbreaks] + +-- +// HOW TO USE SECTION ENDS