From: Peter Meerwald <p.meerwald@bct-electronic.com>
Date: Sun, 11 Dec 2011 15:07:39 +0000 (+0100)
Subject: def: Document that pa_buffer_attr.maxlength is in bytes.
X-Git-Tag: 1.0_branch~187
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=564997e4874a659bbd52a069d94fe981075dd1b7;p=profile%2Fivi%2Fpulseaudio.git

def: Document that pa_buffer_attr.maxlength is in bytes.

Fixes https://bugs.freedesktop.org/show_bug.cgi?id=42919
---

diff --git a/src/pulse/def.h b/src/pulse/def.h
index ca74dfc..98d3651 100644
--- a/src/pulse/def.h
+++ b/src/pulse/def.h
@@ -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. */