diff hs.h @ 5:5f3c32dc6e17

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

--- a/hs.h	Tue Oct 05 17:03:27 2010 +0100
+++ b/hs.h	Wed Oct 06 15:19:49 2010 +0100
@@ -1,8 +1,8 @@
 #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.
 */
@@ -95,7 +95,7 @@
 };
 
 
-/*
+/**
   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.
@@ -123,7 +123,7 @@
 };
 
 
-/*
+/**
   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).
 */
@@ -170,7 +170,7 @@
 };
 
 
-/*
+/**
   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.
@@ -192,7 +192,7 @@
 }; 
 
 
-/*
+/**
   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