mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-10 13:29:58 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

api documentation improvements

Browse source 
includes typo fixes, neatening, addition of more return info, and such.
This commit is contained in:
jnqnfe 2017-09-04 20:19:48 +01:00 • committed by Tanu Kaskinen
parent 7973dfd768
commit b683350856
15 changed files with 205 additions and 143 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/pulse/pulseaudio.h
View file

@ -114,11 +114,11 @@
* integer value or a NULL pointer. On success, zero or a positive integer
* value or a valid pointer is returned.
*
* Functions of the \ref simple generally return -1 or NULL on failure and
* Functions of the \ref simple API generally return -1 or NULL on failure and
* can optionally store an error code (see ::pa_error_code) using a pointer
* argument.
*
* Functions of the \ref async return an negative error code or NULL on
* Functions of the \ref async API return an negative error code or NULL on
* failure (see ::pa_error_code). In the later case, pa_context_errno()
* can be used to obtain the error code of the last failed operation.
*