diff windowfunctions.cpp @ 5:5f3c32dc6e17

* 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 977f541d6683
line wrap: on
line diff
--- a/windowfunctions.cpp	Tue Oct 05 17:03:27 2010 +0100
+++ b/windowfunctions.cpp	Wed Oct 06 15:19:49 2010 +0100
@@ -5,7 +5,7 @@
 #include "align8.h"
 //---------------------------------------------------------------------------
 
-/*
+/**
   function I0: Bessel function of order zero
 
   Returns the Bessel function of x.
@@ -26,7 +26,7 @@
   return S;
 }//I0
 
-/*
+/**
   function FillWindow: fills a buffer $Result with a window function.
 
   In: wt:window type
@@ -103,7 +103,7 @@
 	}
 }//FillWindow
 
-/*
+/**
   function NewWindow: creates a window function.
 
   In: wt: window type
@@ -120,7 +120,7 @@
 	return Result;
 }//NewWindow
 
-/*
+/**
   function NewWindow8: 8-byte aligned version of NewWindow.
 
   In: wt: window type
@@ -139,7 +139,7 @@
 	return Result;
 }//NewWindow8
 
-/*
+/**
   function NewdWindow: computes the derivative of a window function.
 
   In: wt: window type
@@ -205,7 +205,7 @@
 	return Result;
 }//NewdWindow
 
-/*
+/**
   function NewddWindow: computes the 2nd-order derivative of a window function.
 
   In: wt: window type
@@ -273,7 +273,7 @@
 	return Result;
 }//NewddWindow
 
-/*
+/**
   function NewdddWindow: computes the 3rd-order derivative of a window function.
   In: wt: window type
       Count: window size
@@ -336,7 +336,7 @@
 }//NewdddWindow
 
 //---------------------------------------------------------------------------
-/*
+/**
   function windowspec: computes a few descriptors of a cosine family window. A window function in the
   cosine window family is the linear combination of a few cosine functions, therefore has a cosine
   decomposition.