def: Document that pa_buffer_attr.maxlength is in bytes.
authorPeter Meerwald <p.meerwald@bct-electronic.com>
Sun, 11 Dec 2011 15:07:39 +0000 (16:07 +0100)
committerColin Guthrie <colin@mageia.org>
Mon, 12 Dec 2011 22:39:58 +0000 (22:39 +0000)
Fixes https://bugs.freedesktop.org/show_bug.cgi?id=42919

src/pulse/def.h

index ca74dfc..98d3651 100644 (file)
@@ -339,7 +339,7 @@ typedef enum pa_stream_flags {
 /** Playback and record buffer metrics */
 typedef struct pa_buffer_attr {
     uint32_t maxlength;
-    /**< Maximum length of the buffer. Setting this to (uint32_t) -1
+    /**< Maximum length of the buffer in bytes. Setting this to (uint32_t) -1
      * will initialize this to the maximum value supported by server,
      * which is recommended. */