Skip to content

Commit 6d2728c

Browse files
committed
This commit adds descriptive comments for 9f6c6ae.
1 parent 1397023 commit 6d2728c

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

hardware/arduino/avr/cores/arduino/Stream.h

+6-3
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,13 @@
3535
readBytesBetween( pre_string, terminator, buffer, length)
3636
*/
3737

38+
// This enumeration provides the lookahead options for parseInt(), parseFloat()
39+
// The rules set out here are used until either the first valid character is found
40+
// or a time out occurs due to lack of input.
3841
enum StreamParseOpt{
39-
SKIP_ALL,
40-
SKIP_NONE,
41-
SKIP_WHITESPACE
42+
SKIP_ALL, // All invalid characters are ignored.
43+
SKIP_NONE, // Nothing is skipped, and the stream is not touched unless the first waiting character is valid.
44+
SKIP_WHITESPACE // Only tabs, spaces, line feeds & carriage returns are skipped.
4245
};
4346

4447
class Stream : public Print

hardware/arduino/sam/cores/arduino/Stream.h

+6-3
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,13 @@
3535
readBytesBetween( pre_string, terminator, buffer, length)
3636
*/
3737

38+
// This enumeration provides the lookahead options for parseInt(), parseFloat()
39+
// The rules set out here are used until either the first valid character is found
40+
// or a time out occurs due to lack of input.
3841
enum StreamParseOpt{
39-
SKIP_ALL,
40-
SKIP_NONE,
41-
SKIP_WHITESPACE
42+
SKIP_ALL, // All invalid characters are ignored.
43+
SKIP_NONE, // Nothing is skipped, and the stream is not touched unless the first waiting character is valid.
44+
SKIP_WHITESPACE // Only tabs, spaces, line feeds & carriage returns are skipped.
4245
};
4346

4447
class Stream : public Print

0 commit comments

Comments
 (0)