diff procedures.h @ 5:5f3c32dc6e17

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

--- a/procedures.h	Tue Oct 05 17:03:27 2010 +0100
+++ b/procedures.h	Wed Oct 06 15:19:49 2010 +0100
@@ -1,8 +1,8 @@
 #ifndef proceduresH
 #define proceduresH
 
-/*
-  procedures.cpp - this file collects miscellaneous structures and functions. Not all of these are
+/**
+  \file procedures.h - this file collects miscellaneous structures and functions. Not all of these are
   referenced somewhere else.
 */
 
@@ -14,7 +14,7 @@
 #include "fft.h"
 #include "windowfunctions.h"
 
-/*
+/**
   macro testnn: non-negative test. This macro throws out an exception if the value of x is negative.
 */
 #ifndef testnn
@@ -34,7 +34,7 @@
 
 
 //---------------------------------------------------------------------------
-/*
+/**
   Tick count tool (stop watch) is made up of a TickClock struct and three macros that uses this
   structure as augument.
 
@@ -95,7 +95,7 @@
   double ph;      //phase angle
 };
 
-/*
+/**
   TSpecTrack is a class that maintains a list of TSpecPeak objects that form a spectral track. It models
   a sinusid track in sinusoid modeling.
 */
@@ -120,7 +120,7 @@
   int Add(TSpecPeak& APeak);
 };
 
-/*
+/**
   TTFSpans is a class that maintains a list of TFSpans. This is used to mark selected areas in the time-
   frequency plane for further processing.
 */