Changeset 4016 in Sophya for trunk/AddOn/TAcq/brproc.cc

Timestamp:

Aug 12, 2011, 2:26:10 PM (14 years ago)

Author:

ansari

Message:

Ajout de commentaires d'autodocumentation Doxygen, Reza 12/08/2011

File:

• trunk/AddOn/TAcq/brproc.cc (modified) (5 diffs)

trunk/AddOn/TAcq/brproc.cc

@@ -37 +37 @@
 // Le temps correspond au numero de paquet
 //---------------------------------------------------------------------
+/*!
+   \class BRMeanSpecCalculator
+   \ingroup TAcq
+
+   \brief Computes mean spectra on FFT data.
+*/
+
 /* --Methode-- */
 BRMeanSpecCalculator::BRMeanSpecCalculator(RAcqMemZoneMgr& memgr, string outpath, uint_4 nmean, 
@@ -496 +503 @@
 // Classe de thread de calcul de FFT sur donnees RAW 
 //---------------------------------------------------------------------
+/*!
+   \class BRFFTCalculator
+   \ingroup TAcq
+
+   \brief Computes FFT on data from RAW ADC board firmware.
+*/
 /* --Methode-- */
 BRFFTCalculator::BRFFTCalculator(RAcqMemZoneMgr& memgr, bool fgsinglechannel)
@@ -540 +553 @@
 // Classe WBRFFT : Calcul de TF sur donnees brutes (firmware RAW)
 //-------------------------------------------------------------------------
+/*!
+   \class WBRFFT
+   \ingroup TAcq
+
+   \brief Helper class for FFT computation used by BRFFTCalculator class.
+
+   This class uses FFTW library.
+*/
+
 ZMutex* WBRFFT::mtx_fftwp_ = NULL;
 
@@ -604 +626 @@
 //         !!!! OBSOLETE  !!!!   
 //---------------------------------------------------------------
+/*!
+   \class BRProcA2C
+   \ingroup TAcq
+
+   \brief Deprecated processing class. 
+*/
 
 // Mutex pour eviter le plantage du a FFTW qui ne semble pas thread-safe
@@ -1031 +1059 @@
 //         !!!! OBSOLETE  !!!!   
 //---------------------------------------------------------------------
+/*!
+   \class BRProcB4C
+   \ingroup TAcq
+
+   \brief Deprecated processing class. 
+*/
 
 /* --Methode-- */