comparison hs.h @ 5:5f3c32dc6e17

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

 #ifndef hsH
 #define hsH
 
-/*
-  hs.cpp - harmonic sinusoid model
+/**
+  \file hs.h - harmonic sinusoid model
 
   Further reading: Wen X. and M. Sandler, "Sinusoid modeling in a harmonic context," in Proc. DAFx'07, Bordeaux, 2007.
 */
 
 //---------------------------------------------------------------------------

   double* pinf;       //frequencies of pinned partials
   int* pinfr;         //frame indices of pinned partials, used in multi-frame constant-pitch note match
 };
 
 
-/*
+/**
   stiffcandid is the harmonic atom class used internally by harmonic grouping and tracking routines. Literally
   it means "candidate harmonic atoms on a stiff string model". The stiff string is the main harmonic model used
   by me for describing frequency relations between partials of a harmonic sound.
 
   stiffcandid is superceded by TTempAtom class.

   stiffcandid(stiffcandid* prev, int ap, double af, double errf, double ds); //create by updating with new atom
   ~stiffcandid();
 };
 
 
-/*
+/**
   THS is the data structure hosting a harmonic sinusoid representation. Its key members include the number
   of partials, number of frames, and all its atoms (sinusoid parameters of all partials at measurement points).
 */
 
 class THS

   int WriteToStream(TStream* Stream);
   int ReadFromStream(TStream* Stream);
 };
 
 
-/*
+/**
   TPolygon is a polygon class. This class itself does not enforce convexness. However, when used for solving
   the stiff string model, all polygons are convex, as they are the results of current a first convex polygon
   by straight lines.
 
   For the convenience of computation, the sequence of vertices are arranged so that they come in clockwise

   TPolygon(int cap, TPolygon* R);
   ~TPolygon();
 }; 
 
 
-/*
+/**
   TTempAtom is an atom class within the stiff-stirng harmonic atom context used internally by harmonic
   grouping and tracking routines. Literally it means "a temporary atom", and truly it hosts most info
   one expects of a potential atom. TTempAtom replaces stiffcandid class in harmonic sinusoid group and
   tracking algorithms, due to the advanges that it carries atom information (frequency, amplitude, etc.)
   as well as harmonic atom information (link to other atom, the F-G polygon), and is therefore both an