From 2da3c47838ef548ba13965c145c408f0f01b94c9 Mon Sep 17 00:00:00 2001
From: David Fries <david@fries.net>
Date: Tue, 12 Oct 2010 20:05:47 -0500
Subject: 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
---
 src/pulse/simple.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'src/pulse/simple.h')

diff --git a/src/pulse/simple.h b/src/pulse/simple.h
index b1f65374..df8758b0 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
-- 
cgit