Documentation improvement: return code of raw1394_read_cycle_timer{,_and_clock}

"the error code of the ioctl" is always -1.  And ioctl() sets errno for us.
So let's say this in a way which is less likely to be misunderstood.

Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
This commit is contained in:
Stefan Richter 2012-07-31 20:12:14 +02:00
parent 4de07a63b5
commit 77dd78e3b4
1 changed files with 1 additions and 1 deletions

View File

@ -369,7 +369,7 @@ int raw1394_read_cycle_timer(raw1394handle_t handle,
* CLOCK_REALTIME is subject to resets; CLOCK_MONOTONIC is subject to gradual * CLOCK_REALTIME is subject to resets; CLOCK_MONOTONIC is subject to gradual
* adjustments; CLOCK_MONOTONIC_RAW is the bare hardware clock. * adjustments; CLOCK_MONOTONIC_RAW is the bare hardware clock.
* *
* Returns: the error code of the ioctl, or 0 if successful. * Returns: 0 on success or -1 on failure (sets errno)
* *
* History: New function in libraw1394 v2.1.0. * History: New function in libraw1394 v2.1.0.
**/ **/