diff hsedit.cpp @ 5:5f3c32dc6e17

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

--- a/hsedit.cpp	Tue Oct 05 17:03:27 2010 +0100
+++ b/hsedit.cpp	Wed Oct 06 15:19:49 2010 +0100
@@ -3,9 +3,11 @@
 #include "hsedit.h"
 #include "splines.h"
 
+/** \file hsedit.h */
+
 //---------------------------------------------------------------------------
 
-/*
+/**
   function DeFM: frequency de-modulation
 
   In: peakfr[npfr]: segmentation into FM cycles, peakfr[0]=0, peakfr[npfr-1]=Fr-1
@@ -34,7 +36,7 @@
   delete[] frs;
 }//DeFM
 
-/*
+/**
   function DFMSeg: segments HS frames into FM cycles
 
   In: partials[M][Fr]: HS partials
@@ -62,7 +64,7 @@
   delete[] frec;
 }//DFMSeg
 	
-/*
+/**
   function HSAM: harmonic sinusoid amplitude modulation
 
   In: SrcHS: source harmonic sinusoid
@@ -81,7 +83,7 @@
       HS->Partials[m][fr].a=SrcHS->Partials[m][fr].a*(1+dep*cos(omg*SrcHS->Partials[m][fr].t+ph));
 }//HSAM
 
-/*
+/**
   function HSFM: harmonic sinusoid frequency modulation
 
   In: SrcHS: source harmonic sinusoid
@@ -100,7 +102,7 @@
       HS->Partials[m][fr].f=SrcHS->Partials[m][fr].f*(1+pa*cos(omg*SrcHS->Partials[m][fr].t+ph));
 }//HSFM
 
-/*
+/**
   function HSFM_SF: harmonic sinusoid frequency modulation with source-filter model
 
   In: SrcHS: source harmonic sinusoid
@@ -124,7 +126,7 @@
   }
 }//HSFM_SF
 
-/*
+/**
   function: HSPitchShift: harmonic sinusoid pitch shifting
 
   In: SrcHS: source harmonic sinusoid
@@ -139,7 +141,7 @@
   for (int m=0; m<HS->M; m++) for (int fr=0; fr<HS->Fr; fr++) HS->Partials[m][fr].f=SrcHS->Partials[m][fr].f*pa;
 }//HSPitchShift
 
-/*
+/**
   function ReFM: frequency re-modulation
 
   In: partials[M][Fr]: HS partials