diff options
| author | David Fries <david@fries.net> | 2010-10-12 20:05:47 -0500 |
|---|---|---|
| committer | Colin Guthrie <cguthrie@mandriva.org> | 2010-11-17 22:00:47 +0000 |
| commit | f2593da3a36e1cb297a269d98205b4bdcde962f0 (patch) | |
| tree | d2bc75944de719a873ec52258c6107a8deb0c080 /src/pulse/simple.h | |
| parent | 14bc4548cedec372d9ab6a6ed7be3b826b2a6a47 (diff) | |
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
Diffstat (limited to 'src/pulse/simple.h')
| -rw-r--r-- | src/pulse/simple.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/pulse/simple.h b/src/pulse/simple.h index 6f1ba414..8d0a3887 100644 --- a/src/pulse/simple.h +++ b/src/pulse/simple.h @@ -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 |