diff quickspec.cpp @ 5:5f3c32dc6e17

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

--- a/quickspec.cpp	Tue Oct 05 17:03:27 2010 +0100
+++ b/quickspec.cpp	Wed Oct 06 15:19:49 2010 +0100
@@ -4,9 +4,10 @@
 #include <memory.h>
 #include "quickspec.h"
 
+/** \file quickspec.h */
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::TQuickSpectrogram:
 
   In: AParent: pointer argument for calling G, if G is specified
@@ -39,7 +40,7 @@
 }//~TQuickSpectrogram
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::A: accesses amplitude spectrogram by frame
 
   In: fr: frame index, 0-based
@@ -55,7 +56,7 @@
 }//A
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::AddBuffer: increases internal buffer by BufferSize frames. Allocated buffers
   beyond Capacity frames will not be indexed or used by TQuickSpectrogram.
 */
@@ -81,7 +82,7 @@
   BufferCount++;
 }//AddBuffer
 
-/*
+/**
   method TQuickSpectrogram::AddBuffer: increase internal buffer by a multiple of BufferSize so that
   it will be enough to host another AddFrCount frames.
 */
@@ -91,7 +92,7 @@
 }//AddBuffer
 
 //---------------------------------------------------------------------------
-/*
+/**
   function IntToDouble: copy content of integer array to double array
 
   In: in: pointer to integer array
@@ -108,7 +109,7 @@
   else {__pint24 in24=(__pint24)in; for (int k=0; k<Count; k++) *(out++)=*(in24++);}
 }//IntToDouble
 
-/*
+/**
   function CalculateSpectrum: calculate spectrum of a signal in integer format
 
   In: Data[Wid]: integer array hosting waveform data
@@ -132,7 +133,7 @@
   }
 }//CalculateSpectrum
 
-/*
+/**
   function CalculateSpectrum: calculate spectrum of a signal in integer format, allowing the signal
   length $eff be shorter than the DFT size Wid.
 
@@ -168,7 +169,7 @@
     CalculateSpectrum(Data, BytesPerSample, win, Amp, Arg, Wid, w, x, hbi);
 }//CalculateSpectrum
 
-/*
+/**
   method TQuickSpectrogram::CalculateSpectrum: computes spectrogram at fr'th frame.
 
   In: fr: index to the frame whose spectrum is to be computed. fr must be between 0 and Capacity-1.
@@ -229,7 +230,7 @@
 }//CalculateSpectrum
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::FreeBuffers: discards all computed spectra and free all internal buffers.
   This returns the TQuickSpectrogram to its initial state before any frame is accessed. After calling
   FreeBuffers() all frames will be recomputed when they are accessed.
@@ -249,7 +250,7 @@
 }//FreeBuffers
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::Invalidate: renders all frames that have overlap with interval [From, To],
   measured in samples, as invalid. Invalid frames are recomputed when they are accessed again.
 
@@ -271,7 +272,7 @@
 }//Invalidate
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::Ph: accesses phase spectrogram by frame
 
   In: fr: frame index, 0-based
@@ -287,7 +288,7 @@
 }//Ph
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::SetFrCapacity: sets the capacity, i.e. the maximal number of frames handled
   by this TQuickSpectrogram.
 
@@ -331,7 +332,7 @@
 }//SetFrCapacity
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::Ph: accesses complex spectrogram by frame
 
   In: fr: frame index, 0-based