Ticket #130 (closed defect: fixed)

Opened 4 years ago

Last modified 4 years ago

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

Reported by: BenCombee Owned by: lennart
Milestone: 0.9.7 Component: libpulse
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

Changed 4 years ago 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.

Changed 4 years ago by lennart

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

Fixed in r1999

Note: See TracTickets for help on using tickets.