Fixup#2

jpellikk-arm · jpellikk-arm · commit c07ed625ffbe · 2016-03-30T09:13:51.000+03:00
diff --git a/mbed-hal/serial_api.h b/mbed-hal/serial_api.h
@@ -187,7 +187,8 @@ void serial_putc(serial_t *obj, int c);
 int  serial_readable(serial_t *obj);
 
 /** Returns any errors that were encountered by the serial peripheral:
- *  RX overrun, parity error, framing error, or FIFO overflow.
+ *  RX overrun, parity error, framing error, or FIFO overflow. All the
+ *  error flags are cleared after the function call.
  *
  * The return value is a bit field where one bit represents one error
  * type (in the above mentioned order, the least significant bit first).

Original file line number	Diff line number	Diff line change
`@@ -187,7 +187,8 @@ void serial_putc(serial_t *obj, int c);`
`187`	`187`	`int serial_readable(serial_t *obj);`
`188`	`188`
`189`	`189`	`/** Returns any errors that were encountered by the serial peripheral:`
`190`		`- * RX overrun, parity error, framing error, or FIFO overflow.`
	`190`	`+ * RX overrun, parity error, framing error, or FIFO overflow. All the`
	`191`	`+ * error flags are cleared after the function call.`
`191`	`192`	`*`
`192`	`193`	`* The return value is a bit field where one bit represents one error`
`193`	`194`	`* type (in the above mentioned order, the least significant bit first).`