doxygen: Documentation improvements

stream.h, simple.h
The words drain and flush are a little ambiguous, make it explicit as
to what happens to any existing audio.

*mainloop.h
reword *_free and *_get_api for grammar
This commit is contained in:
David Fries 2010-10-12 20:05:47 -05:00 committed by Colin Guthrie
parent 9295e4a0dc
commit 2da3c47838
5 changed files with 16 additions and 15 deletions

View file

@ -140,7 +140,7 @@ int pa_simple_read(pa_simple *s, void*data, size_t bytes, int *error);
/** Return the playback latency. */
pa_usec_t pa_simple_get_latency(pa_simple *s, int *error);
/** Flush the playback buffer. */
/** Flush the playback buffer. This discards any audio in the buffer. */
int pa_simple_flush(pa_simple *s, int *error);
PA_C_DECL_END