Better explanation of ftdi_read_data() behaviour

[libftdi] / src / ftdi.c

diff --git a/src/ftdi.c b/src/ftdi.c
index 9cf425f..de7d81a 100644 (file)
--- a/src/ftdi.c
+++ b/src/ftdi.c
@@ -1547,6 +1547,7 @@ int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunk
 /**
     Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
 
+    Returns when at least one byte is available or when the latency timer has elapsed
     Automatically strips the two modem status bytes transfered during every read.
 
     \param ftdi pointer to ftdi_context