Ticket #130 (closed defect: fixed)

Opened 1 year ago

Last modified 10 months ago

Documentation for pa_simple_read() and pa_simple_write() should indicate units

Reported by: BenCombee Assigned to: lennart
Priority: low Milestone: 0.9.7
Component: libpulse Severity: minor
Keywords: Cc:

Description

While reading the docs for pa_simple_read() and pa_simple_write(), the unit size of the size argument wasn't specified. A client developer can't know if you specify the size of the data in bytes or in number of samples (without checking the source).

See http://0pointer.de/lennart/projects/pulseaudio/doxygen/simple_8h.html#bdc7738caedb001cab413b7b2bd23b6d

This flaw might exist for other places in the docs, this is all that I've read so far.

Change History

09/22/07 16:42:57 changed by lennart

  • status changed from new to assigned.
  • milestone set to 0.9.7.

The fact that the argument is of the POSIX type size_t suggests that this is a memory block measured in bytes.

But you are right, we should document this better.

10/30/07 15:18:08 changed by lennart

  • status changed from assigned to closed.
  • resolution set to fixed.

Fixed in r1999