diff sinest.h @ 5:5f3c32dc6e17

* Adjust comment syntax to permit Doxygen to generate HTML documentation; add Doxyfile

--- a/sinest.h	Tue Oct 05 17:03:27 2010 +0100
+++ b/sinest.h	Wed Oct 06 15:19:49 2010 +0100
@@ -1,8 +1,8 @@
 #ifndef SinEstH
 #define SinEstH
 
-/*
-  SinEst.cpp - sinusoid estimation algorithms
+/**
+  \file sinest.h - sinusoid estimation algorithms
 */
 
 
@@ -118,7 +118,7 @@
 double AmpPhCorrectionExpA(cdouble* s2, int N, cdouble* aita, int L, int T, cdouble* sre, int M, double** h, double** dih, double*** A,	void (*SpecifyA)(int L, int T, int M, int &N, double*** &A, MList* mlist, int mode), int WinOrder);
 
 //--local derivative algorithms - general------------------------------------
-/*
+/**
   template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "v" version,
   i.e. using tuned test functions.
 
@@ -184,7 +184,7 @@
   return result;
 }//DerivativeLSv
 
-/*
+/**
   template DerivativeLS: local derivative algorithm for estimating time-varying sinusoids, "u" version,
   i.e. using base-band test functions.
 
@@ -214,7 +214,7 @@
   return result;
 }//DerivativeLS
 
-/*
+/**
   template DerivativeLS_AmpPh: amplitude and phase estimation in the local derivative algorithm, "u"
   version
 
@@ -238,7 +238,7 @@
   return log(sv0/e0);
 }//DerivativeLS_AmpPh
 
-/*
+/**
   template DerivativeLS_AmpPh: amplitude and phase estimation in the local derivative algorithm, "u"
   version.
 
@@ -265,7 +265,7 @@
 
 cdouble DerivativeLSv_AmpPh(int, int, double**, cdouble*, cdouble*, cdouble); //the "v" version is implemented as a normal function in SinEst.cpp.
 
-/*
+/**
   template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "v" version.
 
   In: s[Wid]: waveform data
@@ -282,7 +282,8 @@
   lmd[0]=DerivativeLSv_AmpPh(Wid, M, integr_h, lmd, v[0], sv0);
 }//DerivativeLSv_AmpPh
 
-/*template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "u" version.
+/**
+  template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "u" version.
 
   In: s[Wid]: waveform data
       u[I][Wid], du[I][Wid]: base-band test functions and their derivatives
@@ -299,7 +300,7 @@
   lmd[0]=DerivativeLS_AmpPh(Wid, M, integr_h, lmd, omg, u[0], s); //sv0);
 }//DerivativeLSv
 
-/*
+/**
   template CosineWindows: generates the Hann^(K/2) window and its L-1 derivatives as Result[L][Wid+1]
 
   In: K, L, Wid