Skip to content

Commit 267e0a2

Browse files
committed
Adjust documentation.
1 parent 53c7fc4 commit 267e0a2

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

lib/application_business_rules/serial_interface/serial_port.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ void initialize();
3333
/**
3434
* Reads a line from serial port.
3535
*
36-
* Interprets the end of line as `\n`.
36+
* Expects the end of line to be `\n`.
3737
* It will wait for data for the duration of the timeout.
3838
* \returns an empty string in case no data is read
3939
*/
@@ -42,7 +42,7 @@ String readLine();
4242
/**
4343
* Gets a line from serial port.
4444
*
45-
* Interprets the end of line as `\n`.
45+
* Expects the end of line to be `\n`.
4646
* \returns an object that does not contain a value in case no data is already available.
4747
*/
4848
std::optional<String> getLine();

0 commit comments

Comments
 (0)