From e44fe2887ad3755c9320b77d8ac3e5162a9ac665 Mon Sep 17 00:00:00 2001
From: Martin Braun <martin.braun@ettus.com>
Date: Fri, 7 Mar 2014 16:18:16 +0100
Subject: vocoder: Fixed GSM GRC bindings and improved docs, provided example

---
 gr-vocoder/doc/vocoder.dox | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'gr-vocoder/doc/vocoder.dox')

diff --git a/gr-vocoder/doc/vocoder.dox b/gr-vocoder/doc/vocoder.dox
index 3973ca56fc..0e12566a80 100644
--- a/gr-vocoder/doc/vocoder.dox
+++ b/gr-vocoder/doc/vocoder.dox
@@ -20,4 +20,14 @@ by using:
     help(vocoder)
 \endcode
 
+\section using Using the vocoders
+
+Note that most vocoders use short inputs instead of floats. This means you
+must convert audio signals from float to short by using a type conversion
+and a scaling factor. See the examples.
+
+The format of the encoded audio is different for every encoder. See the
+individual block's documention for the data format. Encoded data is usually
+a vector of fixed length, and can either be packed or unpacked.
+
 */
-- 
cgit v1.2.3