Doxygen: comments in Algorithms and Samples

Core/Algorithms/inc/Beam.h

@@ -20,8 +20,9 @@
 #include "IParameterized.h"
 #include "EigenCore.h"
 
-
-//! Ideal collimated Beam defined by wavelength, direction and intensity.
+//! @class Beam
+//! @ingroup simulation
+//! @brief Ideal collimated Beam defined by wavelength, direction and intensity.
 
 class BA_CORE_API_ Beam : public IParameterized
 {

Core/Algorithms/inc/ChiSquaredFrequency.h

@@ -18,6 +18,9 @@
 
 #include "IChiSquaredModule.h"
 
+//! @class ChiSquaredFrequency
+//! @ingroup algorithms_internal
+//! @brief Calculation of chi2 in fourier transformed space
 
 class ChiSquaredFrequency : public IChiSquaredModule
 {

Core/Algorithms/inc/ChiSquaredModule.h

@@ -18,6 +18,10 @@
 
 #include "IChiSquaredModule.h"
 
+//! @class ChiSquaredModule
+//! @ingroup algorithms
+//! @brief Calculation of chi2 between two data sets
+
 class BA_CORE_API_ ChiSquaredModule : public IChiSquaredModule
 {
 public:

Core/Algorithms/inc/ConvolutionDetectorResolution.h

@@ -19,8 +19,10 @@
 #include "IDetectorResolution.h"
 #include "IResolutionFunction2D.h"
 
-//! Convolutes the intensity in 1 or 2 dimensions with a resolution function.
-
+//! @class ConvolutionDetectorResolution
+//! @ingroup algorithms
+//! @brief Convolutes the intensity in 1 or 2 dimensions with a resolution function.
+//!
 //! Limitation: this class assumes that the data points are evenly
 //! distributed on each axis
 

Core/Algorithms/inc/DWBADiffuseReflection.h

@@ -21,7 +21,9 @@
 #include "MultiLayer.h"
 #include "SpecularMatrix.h"
 
-//! Calculation of diffuse (aka off-specular) reflection from multilayers.
+//! @class DWBADiffuseReflection
+//! @ingroup algorithms_internal
+//! @brief Calculation of diffuse (aka off-specular) reflection from multilayers.
 
 class BA_CORE_API_ DWBADiffuseReflection : public ISimulation
 {

Core/Algorithms/inc/DWBASimulation.h

@@ -23,7 +23,10 @@
 #include "Types.h"
 #include "EigenCore.h"
 
-//! Base class for different simulations, using DWBA.
+
+//! @class DWBASimulation
+//! @ingroup algorithms_internal
+//! @brief Base class for different simulations, using DWBA.
 
 class DWBASimulation : public ISimulation
 {

Core/Algorithms/inc/DecoratedLayerDWBASimulation.h

@@ -22,7 +22,9 @@
 
 class Layer;
 
-//! Calculates scattering cross sections in DWBA for a layer with particles in/on it
+//! @class DecoratedLayerDWBASimulation
+//! @ingroup algorithms_internal
+//! @brief Calculates scattering cross sections in DWBA for a layer with particles in/on it
 
 class DecoratedLayerDWBASimulation : public LayerDWBASimulation
 {

Core/Algorithms/inc/DecouplingApproximationStrategy.h

@@ -19,6 +19,10 @@
 #include "Types.h"
 #include "IInterferenceFunctionStrategy.h"
 
+//! @class DecouplingApproximationStrategy
+//! @ingroup algorithms_internal
+//! @brief Strategy for implementing decoupling approximation
+
 class DecouplingApproximationStrategy : public IInterferenceFunctionStrategy
 {
 public:

Core/Algorithms/inc/Detector.h

@@ -22,7 +22,6 @@
 #include "EigenCore.h"
 
 
-
 //! @class Detector
 //! @ingroup simulation
 //! @brief The detector with axes and resolution function.

Core/Algorithms/inc/DetectorParameters.h

@@ -18,7 +18,9 @@
 
 #include "TRange.h"
 
-//! Store parameters for specifying one axis
+//! @class AxisParameters
+//! @ingroup simulation_internal
+//! @brief Store parameters for specifying one axis
 
 struct AxisParameters
 {
@@ -38,7 +40,9 @@ inline AxisParameters::AxisParameters()
 {
 }
 
-//! Store parameters for specifying a 2D detector.
+//! @class DetectorParameters
+//! @ingroup simulation_internal
+//! @brief Store parameters for specifying a 2D detector.
 
 struct DetectorParameters
 {

Core/Algorithms/inc/DiffuseDWBASimulation.h

@@ -19,6 +19,10 @@
 #include "LayerDWBASimulation.h"
 #include "DiffuseParticleInfo.h"
 
+//! @class DiffuseDWBASimulation
+//! @ingroup algorithms_internal
+//! @brief Calculation of diffuse scattering in DWBA
+
 class DiffuseDWBASimulation: public LayerDWBASimulation
 {
 public:

Core/Algorithms/inc/FTDistributions.h

@@ -22,6 +22,11 @@
 
 #include "Numeric.h"
 
+
+//! @class IFTDistribution1D
+//! @ingroup algorithms_internal
+//! @brief Interface for 1 dimensional distributions in Fourier space
+
 class IFTDistribution1D
 {
 public:
@@ -33,7 +38,10 @@ protected:
     double m_omega;
 };
 
-//! Interface for 2 dimensional distributions in Fourier space
+
+//! @class IFTDistribution2D
+//! @ingroup algorithms_internal
+//! @brief Interface for 2 dimensional distributions in Fourier space
 class BA_CORE_API_ IFTDistribution2D : public IParameterized
 {
 public:
@@ -78,8 +86,12 @@ protected:
     double m_delta;
 };
 
-//! 2 dimensional Cauchy distribution in Fourier space
+
+//! @class FTDistribution2DCauchy
+//! @ingroup algorithms
+//! @brief 2 dimensional Cauchy distribution in Fourier space
 //! corresponds to exp(-r) in real space
+
 class BA_CORE_API_ FTDistribution2DCauchy : public IFTDistribution2D
 {
 public:
@@ -91,8 +103,12 @@ public:
     virtual double evaluate(double qx, double qy) const;
 };
 
-//! 2 dimensional Gauss distribution in Fourier space
+
+//! @class FTDistribution2DGauss
+//! @ingroup algorithms
+//! @brief 2 dimensional Gauss distribution in Fourier space
 //! corresponds to exp(-r^2) in real space
+
 class BA_CORE_API_ FTDistribution2DGauss : public IFTDistribution2D
 {
 public:
@@ -104,8 +120,12 @@ public:
     virtual double evaluate(double qx, double qy) const;
 };
 
-//! 2 dimensional Voigt distribution in Fourier space
+
+//! @class FTDistribution2DVoigt
+//! @ingroup algorithms
+//! @brief 2 dimensional Voigt distribution in Fourier space
 //! Corresponds to eta*Gauss + (1-eta)*Cauchy
+
 class BA_CORE_API_ FTDistribution2DVoigt : public IFTDistribution2D
 {
 public:

Core/Algorithms/inc/IChiSquaredModule.h

@@ -21,7 +21,10 @@
 #include "IOutputDataNormalizer.h"
 #include "IIntensityFunction.h"
 
-//! Interface for ChiSquaredModule, ChiSquaredFrequency.
+
+//! @class IChiSquaredModule
+//! @ingroup algorithms_internal
+//! @brief Interface for ChiSquaredModule, ChiSquaredFrequency for chi2 calculations.
 
 class BA_CORE_API_ IChiSquaredModule : public ICloneable
 {

Core/Algorithms/inc/IDetectorResolution.h

@@ -21,6 +21,11 @@
 #include "ICloneable.h"
 #include "EigenCore.h"
 
+
+//! @class IDetectorResolution
+//! @ingroup algorithms_internal
+//! @brief Interface for detector resolution algorithms
+
 class BA_CORE_API_ IDetectorResolution : public ICloneable, public IParameterized
 {
 public:

Core/Algorithms/inc/IFittingDataSelector.h

@@ -18,6 +18,11 @@
 
 #include "OutputData.h"
 
+
+//! @class IFittingDataSelector
+//! @ingroup algorithms_internal
+//! @brief Interface for selecting data points and its weights
+
 class IFittingDataSelector
 {
 public:
@@ -29,6 +34,11 @@ public:
         const OutputData<double>& simulated_data) const=0;
 };
 
+
+//! @class DefaultAllDataSelector
+//! @ingroup algorithms_internal
+//! @brief Default algorithm for selecting all data points and giving them equal weight of 1.
+
 class DefaultAllDataSelector : public IFittingDataSelector
 {
 public:

Core/Algorithms/inc/IIntensityFunction.h

@@ -19,6 +19,11 @@
 
 #include <cmath>
 
+
+//! @class IIntensityFunction
+//! @ingroup algorithms_internal
+//! @brief Interface for applying arbitrary function to the measured intensity
+
 class IIntensityFunction
 {
 public:
@@ -28,6 +33,11 @@ public:
     virtual double evaluate(double value) const=0;
 };
 
+
+//! @class IntensityFunctionLog
+//! @ingroup algorithms_internal
+//! @brief Algorithm for applying log function to the measured intensity
+
 class IntensityFunctionLog : public IIntensityFunction
 {
 public:
@@ -38,6 +48,11 @@ public:
         return (value > 0 ? std::log(value) : 0); }
 };
 
+
+//! @class IntensityFunctionSqrt
+//! @ingroup algorithms_internal
+//! @brief Algorithm for applying sqrt function to the measured intensity
+
 class IntensityFunctionSqrt : public IIntensityFunction
 {
 public:

Core/Algorithms/inc/IInterferenceFunctionStrategy.h

@@ -25,6 +25,11 @@
 
 #include <vector>
 
+
+//! @class IInterferenceFunctionStrategy
+//! @ingroup algorithms_internal
+//! @brief Algorithm to apply one of interference function strategies (LMA, SCCA etc)
+
 class IInterferenceFunctionStrategy
 {
 public:

Core/Algorithms/inc/ILayerRTCoefficients.h

@@ -19,6 +19,11 @@
 #include "Types.h"
 #include "EigenCore.h"
 
+
+//! @class ILayerRTCoefficients
+//! @ingroup algorithms_internal
+//! @brief Interface to access reflection/transmition coefficients
+
 class ILayerRTCoefficients
 {
 public:

Core/Algorithms/inc/IOutputDataNormalizer.h

@@ -20,7 +20,10 @@
 #include "IParameterized.h"
 #include "OutputData.h"
 
-//! Interface to OutputData normalizers.
+
+//! @class IOutputDataNormalizer
+//! @ingroup algorithms_internal
+//! @brief Interface to OutputData normalizers.
 
 class BA_CORE_API_ IOutputDataNormalizer : public IParameterized
 {
@@ -35,7 +38,10 @@ public:
     virtual void setMaximumIntensity(double ) = 0;
 };
 
-//! Standard OutputData normalizer, with configurable max_intensity.
+
+//! @class OutputDataNormalizer
+//! @ingroup algorithms_internal
+//! @brief Standard OutputData normalizer, with configurable max_intensity.
 
 class BA_CORE_API_ OutputDataNormalizer : public IOutputDataNormalizer
 {
@@ -65,7 +71,10 @@ protected:
     double m_max_intensity;
 };
 
-//! Simplified OutputData normalizer, with max_intensity=1.
+
+//! @class OutputDataSimpleNormalizer
+//! @ingroup algorithms_internal
+//! @brief Simplified OutputData normalizer, with max_intensity=1.
 
 class OutputDataSimpleNormalizer : public OutputDataNormalizer
 {

Core/Algorithms/inc/IResolutionFunction2D.h

@@ -18,7 +18,10 @@
 
 #include "IParameterized.h"
 
-//! Interface providing two-dimensional resolution function.
+
+//! @class IResolutionFunction2D
+//! @ingroup algorithms_internal
+//! @brief Interface providing two-dimensional resolution function.
 
 class BA_CORE_API_ IResolutionFunction2D : public IParameterized
 {