comment above fm_mod_comp modified

git-svn-id: https://svn.code.sf.net/p/freetel/code@2305 01035d8c-6547-0410-b346-abe4f91aad63

diff --git a/codec2-dev/src/fm.c b/codec2-dev/src/fm.c
index 37e7a97aa5d612d6934f94a9758a60437e0298fc..42c9b903e3b66654b6db6b2586768c2c8e97d4d0 100644 (file)
--- a/codec2-dev/src/fm.c
+++ b/codec2-dev/src/fm.c
@@ -246,11 +246,12 @@ void fm_mod(struct FM *fm_states, float tx_in[], float tx_out[]){
   AUTHOR......: Brady O'Brien                        
   DATE CREATED: Sept. 10 2015
 
-  Modulate an FM signal from a baseband modulating signal
+  Modulate an FM signal from a baseband modulating signal. Output signal is
+   in complex domain
 
   struct FM *fm - FM state structure. Can be reused from fm_demod.
   float tx_in[] - nsam baseband samples to be modulated
-  float tx_out[] - nsam samples in which to place the modulated FM
+  COMP tx_out[] - nsam samples in which to place the modulated FM
 
 \*---------------------------------------------------------------------------*/