simple: Improve pa_simple_read() documentation
authorTanu Kaskinen <tanuk@iki.fi>
Fri, 4 Oct 2013 10:39:40 +0000 (13:39 +0300)
committerTanu Kaskinen <tanu.kaskinen@linux.intel.com>
Tue, 29 Oct 2013 18:53:48 +0000 (20:53 +0200)
commit073051f9830d056a96910589a7505345ebe77ab1
tree1f9dd94aaf712df1bcb65c3ec614f46c5e6cae6c
parent38b8c42b357c31d847c6715f20ce28fde9fc62a2
simple: Improve pa_simple_read() documentation

There was a question in IRC about whether pa_simple_read() blocks or
not. It's already documented on the simple API overview page, but it's
good to say it also in the function reference. As a bonus, I added
some additional details to the documentation too.
src/pulse/simple.h