]> sigrok.org Git - libsigrok.git/commit
serial: update doxygen comments (flush vs drain, in vs out params)
authorGerhard Sittig <redacted>
Sun, 19 Mar 2017 15:11:56 +0000 (16:11 +0100)
committerGerhard Sittig <redacted>
Sun, 28 Apr 2019 15:41:12 +0000 (17:41 +0200)
commit6213c38ef8f1c38692335869e4052490e48711f9
tree5e0f7fb31c9ba1b82527f4e447d2d5160050b45a
parentfcfa36fd6fd671e032697f2690a1b459324a386e
serial: update doxygen comments (flush vs drain, in vs out params)

It's important to remain aware that the serial layer's flush and drain
semantics differs from e.g. filesystem calls. The libserialport API is
said to follow the termios example.

Extend comments in the libsigrok API, to not depend on the libserialport
layer and the availability of its documentation. This raises awareness
during maintenance of sigrok device drivers, as well as the pending
addition of alternative transports for serial communication.

Adjust the doxygen comment for the read line routine while we are here.
Add "in" and "out" attributes for routine parameters.
src/serial.c