[Morse2txt-checkins] morse2txt/src agc.h,1.8,1.9 agc.c,1.7,1.8

[Ken P. <kp...@us...>]

Update of /cvsroot/morse2txt/morse2txt/src
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24779/src

Modified Files:
	agc.h agc.c 
Log Message:
fix doxygen errors

Index: agc.h
===================================================================
RCS file: /cvsroot/morse2txt/morse2txt/src/agc.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** agc.h	11 Aug 2005 00:30:18 -0000	1.8
--- agc.h	19 Aug 2005 15:52:53 -0000	1.9
***************
*** 37,47 ****
  typedef struct s_agc *agc;
  
! /** Creates, and returns a pointer to an agc object.
!  *  \sa agc_destroy
   *  \param max_gain  The maximum gain of the agc object.
   *  \param min_gain  The minimum gain of the agc object.
!  *  \param fft_noise_floor  The minimum amplitude required to compute a ngew gain.
   *  \param max_amp  The maximum amplitude desired.
!  *  \param correction_type The type of AGC gain correction. 
   *  \param gain_increase_correct The factor by which the gain will be increased.
   *  \param gain_decrease_correct  The factor by which the gain will be decreased.
--- 37,46 ----
  typedef struct s_agc *agc;
  
! /** Creates, and returns a pointer to an agc object. @sa agc_destroy
   *  \param max_gain  The maximum gain of the agc object.
   *  \param min_gain  The minimum gain of the agc object.
!  *  \param noise_floor  The minimum amplitude required to compute a ngew gain.
   *  \param max_amp  The maximum amplitude desired.
!  *  \param agc_type The type of AGC gain correction. 
   *  \param gain_increase_correct The factor by which the gain will be increased.
   *  \param gain_decrease_correct  The factor by which the gain will be decreased.
***************
*** 56,67 ****
  
  /** De-allocates the automatic gain object.
!  *  \sa agc_create
   */
  void agc_destroy(agc *gain_object);
  
! /** Updates the agc gain, returns the new gain.
!  *  \sa agc_create
!  *  \param agc pointer to automatic gain object.
!  *  \param current_amplitude  The curretn amplitude.
   */
  double agc_update(agc gain_object, double current_amplitude);
--- 55,65 ----
  
  /** De-allocates the automatic gain object.
!  *  @param gain_object Pointer to the gain object to destroy. @sa agc @sa agc_create
   */
  void agc_destroy(agc *gain_object);
  
! /** Updates the agc gain, returns the new gain. \sa agc_create
!  *  @param gain_object Automatic gain control object.
!  *  @param current_amplitude  The current amplitude.
   */
  double agc_update(agc gain_object, double current_amplitude);

Index: agc.c
===================================================================
RCS file: /cvsroot/morse2txt/morse2txt/src/agc.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** agc.c	2 May 2005 00:37:02 -0000	1.7
--- agc.c	19 Aug 2005 15:52:53 -0000	1.8
***************
*** 35,39 ****
  #include "agc.h"
  
! /** \struct s_agc  AGC object private members. */
  typedef struct s_agc
  {
--- 35,39 ----
  #include "agc.h"
  
! /** AGC object private members. */
  typedef struct s_agc
  {