diff options
author | Lennart Poettering <lennart@poettering.net> | 2004-08-23 18:48:34 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2004-08-23 18:48:34 +0000 |
commit | b6b428e5cbfc2440f5950c0744e15bc4d84e6b31 (patch) | |
tree | 62f1aeb25cf211449e493dda5b92586f671cda22 /polyp/polyplib-stream.h | |
parent | 41295bbf56ef6df0a0e705149475d91c8d83ff3f (diff) |
minor documentation update
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@153 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'polyp/polyplib-stream.h')
-rw-r--r-- | polyp/polyplib-stream.h | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/polyp/polyplib-stream.h b/polyp/polyplib-stream.h index ff313326..a0cbe521 100644 --- a/polyp/polyplib-stream.h +++ b/polyp/polyplib-stream.h @@ -83,7 +83,7 @@ void pa_stream_write(struct pa_stream *p /**< The stream to use */, playback buffer. Normally you will specify 0 here, - .i.e. append to the + i.e. append to the playback buffer. If the value given here is greater than the @@ -113,14 +113,12 @@ void pa_stream_set_write_callback(struct pa_stream *p, void (*cb)(struct pa_stre /** Set the callback function that is called when new data is available from the stream */ void pa_stream_set_read_callback(struct pa_stream *p, void (*cb)(struct pa_stream *p, const void*data, size_t length, void *userdata), void *userdata); -/** Pause (or resume) playback of this stream temporarily - * \since 0.3 */ +/** Pause (or resume) playback of this stream temporarily. \since 0.3 */ struct pa_operation* pa_stream_cork(struct pa_stream *s, int b, void (*cb) (struct pa_stream*s, int success, void *userdata), void *userdata); /** Flush the playback buffer of this stream. Most of the time you're - * better off using the delta of pa_stream_write() instead of this - * function. - * \since 0.3*/ + * better off using the parameter delta of pa_stream_write() instead of this + * function. \since 0.3 */ struct pa_operation* pa_stream_flush(struct pa_stream *s, void (*cb)(struct pa_stream *s, int success, void *userdata), void *userdata); PA_C_DECL_END |