Merge pull request #994 from rbeerwerth/develop

Updated doxygen comments

Core/Computation/SpecularComputationTerm.h

@@ -28,6 +28,9 @@ class Slice;
 
 //! Computes the specular scattering.
 //! Used by SpecularComputation.
+//!
+//! Inherited by SpecularScalarTerm, SpecularMatrixTerm
+//!
 //! @ingroup algorithms_internal
 
 class SpecularComputationTerm
@@ -51,6 +54,10 @@ private:
     std::unique_ptr<DelayedProgressCounter> mP_progress_counter;
 };
 
+//! Computes the specular scattering for a scalar sample
+//! Used by SpecularComputation.
+//! @ingroup algorithms_internal
+
 class SpecularScalarTerm : public SpecularComputationTerm
 {
 public:
@@ -63,6 +70,10 @@ protected:
     void eval(SpecularSimulationElement& elem, const std::vector<Slice>& slices) const override;
 };
 
+//! Computes the specular scattering for a magnetic sample
+//! Used by SpecularComputation.
+//! @ingroup algorithms_internal
+
 class SpecularMatrixTerm : public SpecularComputationTerm
 {
 public:

Core/Multilayer/ISpecularStrategy.h

@@ -18,6 +18,13 @@
 #include "ILayerRTCoefficients.h"
 #include "Slice.h"
 
+//! Interface for the Fresnel computations, both in the scalar and magnetic case
+//!
+//! Inherited by SpecularScalarStrategy, SpecularMagneticOldStrategy,
+//! SpecularMagneticStrategy, SpecularMagneticNewStrategy
+
+//! @ingroup algorithms_internal
+
 class BA_CORE_API_ ISpecularStrategy
 {
 public:

Core/Multilayer/SpecularMagneticStrategy.h

@@ -23,8 +23,12 @@
 
 class Slice;
 
+//! Implements the magnetic Fresnel computation without roughness
+//!
 //! Implements the matrix formalism for the calculation of wave amplitudes of
 //! the coherent wave solution in a multilayer with magnetization.
+//! For a detailed description see internal document "Polarized Specular Reflectometry"
+//!
 //! @ingroup algorithms_internal
 class BA_CORE_API_ SpecularMagneticStrategy : public ISpecularStrategy
 {

Core/Multilayer/SpecularScalarNCStrategy.h

@@ -19,8 +19,12 @@
 
 class Slice;
 
-//! Implements method 'execute' to compute refraction angles and transmission/reflection
-//! coefficients for coherent wave propagation in a multilayer.
+//! Implements Nevot-Croce roughness for a scaler computation.
+//!
+//! Implements the transition function that includes Nevot-Croce roughness
+//! in the computation of the coefficients for coherent wave propagation
+//! in a multilayer by applying modified Fresnel coefficients.
+//!
 //! @ingroup algorithms_internal
 
 class BA_CORE_API_ SpecularScalarNCStrategy : public SpecularScalarStrategy

Core/Multilayer/SpecularScalarStrategy.h

@@ -23,10 +23,14 @@
 
 class Slice;
 
+//! Implements the scalar Fresnel computation
+//!
 //! Implements method 'execute' to compute refraction angles and transmission/reflection
 //! coefficients for coherent wave propagation in a multilayer.
+//!
+//! Inherited by SpecularScalarNCStrategy, SpecularScalarTanhStrategy
+//!
 //! @ingroup algorithms_internal
-
 class BA_CORE_API_ SpecularScalarStrategy : public ISpecularStrategy
 {
 public:

Core/Multilayer/SpecularScalarTanhStrategy.h

@@ -19,10 +19,13 @@
 
 class Slice;
 
-//! Implements method 'execute' to compute refraction angles and transmission/reflection
-//! coefficients for coherent wave propagation in a multilayer.
+//! Implements an tanh transition function to model roughness in a scaler computation.
+//!
+//! Implements the transition function that includes the analytical roughness model
+//! of an tanh interface transition in the computation of the coefficients for
+//! coherent wave propagation in a multilayer by applying modified Fresnel coefficients.
+//!
 //! @ingroup algorithms_internal
-
 class BA_CORE_API_ SpecularScalarTanhStrategy : public SpecularScalarStrategy
 {
 private: