Commit 1dc91c3c authored by Karl Wette's avatar Karl Wette

ComputeFstat: add ComputeFstat_Demod.c and ComputeFstat_Resamp.c module documentation groups

parent 69f35b0c
......@@ -31,6 +31,15 @@
#include <lal/LogPrintf.h>
#include <lal/SinCosLUT.h>
///
/// \defgroup ComputeFstat_Demod_c Module ComputeFstat_Demod.c
/// \ingroup ComputeFstat_h
/// \brief Implements the \a Demod Dirichlet kernel-based demodulation algorithm
/// for computing the \f$\mathcal{F}\f$-statistic \cite Williams1999
///
// @{
// ========== Demod internals ==========
// ----- local types ----------
......@@ -551,3 +560,5 @@ XLALDestroyFstatInputTimeslice_Demod ( void *method_data )
return;
} // XLALDestroyFstatInputTimeslice_Demod()
// @}
......@@ -35,6 +35,15 @@
#include <lal/TimeSeries.h>
#include <lal/Units.h>
///
/// \defgroup ComputeFstat_Resamp_c Module ComputeFstat_Resamp.c
/// \ingroup ComputeFstat_h
/// \brief Implements the \a Resamp: FFT-based resampling algorithm for
/// computing the \f$\mathcal{F}\f$-statistic \cite JKS98
///
// @{
// ========== Resamp internals ==========
// ----- local macros ----------
......@@ -1207,3 +1216,5 @@ XLALGetFstatTiming_Resamp ( const void *method_data, FstatTimingGeneric *timingG
return XLAL_SUCCESS;
} // XLALGetFstatTiming_Resamp()
// @}
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment