Mercurial > hg > x

diff sinsyn.h @ 5:5f3c32dc6e17

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Adjust comment syntax to permit Doxygen to generate HTML documentation; add Doxyfile
author Chris Cannam
date Wed, 06 Oct 2010 15:19:49 +0100
parents fc19d45615d1
children 9b1c0825cc77
line wrap: on
line diff
--- a/sinsyn.h	Tue Oct 05 17:03:27 2010 +0100
+++ b/sinsyn.h	Wed Oct 06 15:19:49 2010 +0100
@@ -1,8 +1,8 @@
 #ifndef SinSynH
 #define SinSynH
 
-/*
-  SinSyn.h - sinusoid synthesis routines for sinusoid modeling cycle. Functions named Sinusoid construct
+/**
+  \file sinsyn.h - sinusoid synthesis routines for sinusoid modeling cycle. Functions named Sinusoid construct
   sinusoid segments whose amplitude and frequency are modeled as polynomials or linear combinations of
   basis functions; functions named SinusoidExp construct sinusoid segments whose logarithmic amplitude
   derivative and frequency are modeled thus; functions named SinusoidExpA construct sinusoid segments