Commenting in Formfactors

Core/FormFactors/inc/FormFactorAnisoPyramid.h

@@ -19,16 +19,18 @@
 #include "IFormFactorBorn.h"
 #include "IStochasticParameter.h"
 
-//! Form factor of an anisotropic pyramid.
+//! @class FormFactorAnisoPyramid
+//! @ingroup formfactors
+//! @brief The formfactor of an anisotropic pyramid.
 
 class BA_CORE_API_ FormFactorAnisoPyramid : public IFormFactorBorn
 {
 public:
     //! @brief anisotropic pyramid constructor
-    //! @param height of anisotropic pyramide
     //! @param length of anisotropic pyramid's base
     //! @param width of anisotropic pyramid's base
-    //! @param angle in radians between base and facet
+    //! @param height of anisotropic pyramide
+    //! @param alpha angle in radians between base and facet
     FormFactorAnisoPyramid(double length, double width, double height, double alpha);
 
     ~FormFactorAnisoPyramid() {}
@@ -62,4 +64,5 @@ private:
     double m_alpha;
 };
 
+
 #endif // FORMFACTORANISOPYRAMID_H

Core/FormFactors/inc/FormFactorBox.h

@@ -19,7 +19,9 @@
 #include "IFormFactorBorn.h"
 #include "IStochasticParameter.h"
 
-//! The form factor for a rectangular box
+//! @class FormFactorBox
+//! @ingroup formfactors
+//! @brief The formfactor for a rectangular box.
 
 class BA_CORE_API_ FormFactorBox : public IFormFactorBorn
 {

Core/FormFactors/inc/FormFactorCone.h

@@ -20,7 +20,9 @@
 #include "IStochasticParameter.h"
 #include "MemberComplexFunctionIntegrator.h"
 
-//! Form factor of a cone.
+//! @class FormFactorCone
+//! @ingroup formfactors
+//! @brief The formfactor of a cone.
 
 class BA_CORE_API_ FormFactorCone : public IFormFactorBorn
 {

Core/FormFactors/inc/FormFactorCone6.h

@@ -20,7 +20,9 @@
 #include "IStochasticParameter.h"
 #include "MemberComplexFunctionIntegrator.h"
 
-//! Form factor of a cone6.
+//! @class FormFactorCone6
+//! @ingroup formfactors
+//! @brief The formfactor of a cone6.
 
 class BA_CORE_API_ FormFactorCone6 : public IFormFactorBorn
 {

Core/FormFactors/inc/FormFactorCrystal.h

@@ -19,7 +19,9 @@
 #include "IFormFactorBorn.h"
 #include "Crystal.h"
 
-//! Form factor for mesocrystals with a bulk crystal structure of particles
+//! @class FormFactorCrystal
+//! @ingroup formfactors
+//! @brief The formfactor for mesocrystals with a bulk crystal structure of particles.
 
 class BA_CORE_API_ FormFactorCrystal : public IFormFactorBorn
 {

Core/FormFactors/inc/FormFactorCuboctahedron.h

@@ -19,7 +19,9 @@
 #include "IFormFactorBorn.h"
 #include "IStochasticParameter.h"
 
-//! Form factor of cuboctahedron.
+//! @class FormFactorCuboctahedron
+//! @ingroup formfactors
+//! @brief The formfactor of cuboctahedron.
 
 class BA_CORE_API_ FormFactorCuboctahedron : public IFormFactorBorn
 {

Core/FormFactors/inc/FormFactorCylinder.h

@@ -18,7 +18,9 @@
 
 #include "IFormFactorBorn.h"
 
-//! Form factor of a cylinder.
+//! @class FormFactorCylinder
+//! @ingroup formfactors
+//! @brief The formfactor of a cylinder.
 
 class BA_CORE_API_ FormFactorCylinder : public IFormFactorBorn
 {

Core/FormFactors/inc/FormFactorDWBA.h

@@ -19,7 +19,9 @@
 #include "IFormFactorDecorator.h"
 #include "LayerSpecularInfo.h"
 
-//! Evaluates a coherent sum of the four DWBA terms in a scalar form factor
+//! @class FormFactorDWBA
+//! @ingroup ff_decorations
+//! @brief Evaluates a coherent sum of the four DWBA terms in a scalar formfactor.
 
 class BA_CORE_API_ FormFactorDWBA: public IFormFactorDecorator
 {

Core/FormFactors/inc/FormFactorDWBAConstZ.h

@@ -18,7 +18,9 @@
 
 #include "FormFactorDWBA.h"
 
-//! Calculates a DWBA form factor for particles at fixed depth
+//! @class FormFactorDWBAConstZ
+//! @ingroup ff_decorations
+//! @brief Calculates a DWBA formfactor for particles at fixed depth.
 
 class BA_CORE_API_ FormFactorDWBAConstZ : public FormFactorDWBA
 {

Core/FormFactors/inc/FormFactorDWBAPol.h

@@ -19,7 +19,9 @@
 #include "IFormFactor.h"
 #include "LayerSpecularInfo.h"
 
-//! Evaluates a coherent sum of the 16 matrix DWBA terms in a polarized form factor
+//! @class FormFactorDWBAPol
+//! @ingroup ff_internals
+//! @brief Evaluates a coherent sum of the 16 matrix DWBA terms in a polarized formfactor.
 
 class BA_CORE_API_ FormFactorDWBAPol : public IFormFactor
 {

Core/FormFactors/inc/FormFactorDWBAPolConstZ.h

@@ -18,7 +18,9 @@
 
 #include "FormFactorDWBAPol.h"
 
-//! Calculates a polarized DWBA form factor for particles at fixed depth
+//! @class FormFactorDWBAPolConstZ
+//! @ingroup ff_internals
+//! @brief Calculates a polarized DWBA formfactor for particles at fixed depth.
 
 class BA_CORE_API_ FormFactorDWBAPolConstZ : public FormFactorDWBAPol
 {

Core/FormFactors/inc/FormFactorDecoratorDebyeWaller.h

@@ -18,7 +18,9 @@
 
 #include "IFormFactorDecorator.h"
 
-//! Debye-Waller factors in radial and z directions.
+//! @class FormFactorDecoratorDebyeWaller
+//! @ingroup ff_decorations
+//! @brief Debye-Waller factors in radial and z directions.
 
 class BA_CORE_API_ FormFactorDecoratorDebyeWaller : public IFormFactorDecorator
 {

Core/FormFactors/inc/FormFactorDecoratorFactor.h

@@ -18,7 +18,9 @@
 
 #include "IFormFactorDecorator.h"
 
-//! Decorates a form factor with a constant factor
+//! @class FormFactorDecoratorFactor
+//! @ingroup ff_decorations
+//! @brief Decorates a formfactor with a constant factor.
 
 class BA_CORE_API_ FormFactorDecoratorFactor : public IFormFactorDecorator
 {

Core/FormFactors/inc/FormFactorDecoratorMaterial.h

@@ -20,8 +20,10 @@
 #include "HomogeneousMaterial.h"
 #include <memory>
 
-//! Decorates a scalar form factor with the correct factor for the material's
-//! refractive index and that of its surrounding material
+//! @class FormFactorDecoratorMaterial
+//! @ingroup ff_decorations
+//! @brief Decorates a scalar formfactor with the correct factor for the material's
+//! refractive index and that of its surrounding material.
 
 class BA_CORE_API_  FormFactorDecoratorMaterial : public FormFactorDecoratorFactor
 {

Core/FormFactors/inc/FormFactorDecoratorMultiPositionFactor.h

@@ -18,7 +18,9 @@
 
 #include "IFormFactorDecorator.h"
 
-//! Form factor for the same particle at different fixed positions
+//! @class FormFactorDecoratorMultiPositionFactor
+//! @ingroup ff_decorations
+//! @brief The formfactor for the same particle at different fixed positions.
 
 class FormFactorDecoratorMultiPositionFactor : public IFormFactorDecorator
 {

Core/FormFactors/inc/FormFactorDecoratorPositionFactor.h

@@ -19,7 +19,9 @@
 #include "Types.h"
 #include "IFormFactorDecorator.h"
 
-//! Decorates a form factor with a position dependent phase factor
+//! @class FormFactorDecoratorPositionFactor
+//! @ingroup ff_decorations
+//! @brief Decorates a formfactor with a position dependent phase factor.
 
 class FormFactorDecoratorPositionFactor : public IFormFactorDecorator
 {

Core/FormFactors/inc/FormFactorDecoratorTransformation.h

@@ -20,7 +20,9 @@
 #include "ITransform3D.h"
 #include <memory>
 
-//! Equip a Formfactor with a rotation.
+//! @class FormFactorDecoratorTransformation
+//! @ingroup ff_decorations
+//! @brief Equip a formfactor with a rotation.
 
 class FormFactorDecoratorTransformation : public IFormFactorDecorator
 {

Core/FormFactors/inc/FormFactorEllipsoidalCylinder.h

@@ -19,7 +19,9 @@
 #include "IFormFactorBorn.h"
 #include "IStochasticParameter.h"
 
-//! Form factor of an ellipsoidal cylinder.
+//! @class FormFactorEllipsoidalCylinder
+//! @ingroup formfactors
+//! @brief The formfactor of an ellipsoidal cylinder.
 
 class BA_CORE_API_ FormFactorEllipsoidalCylinder : public IFormFactorBorn
 {

Core/FormFactors/inc/FormFactorFullSphere.h

@@ -19,8 +19,9 @@
 #include "IFormFactorBorn.h"
 #include "IStochasticParameter.h"
 
-//! Formfactor of a sphere.
-
+//! @ingroup formfactors
+//! @class FormFactorFullSphere
+//! @brief The formfactor of a sphere.
 class BA_CORE_API_ FormFactorFullSphere : public IFormFactorBorn
 {
 public:

Core/FormFactors/inc/FormFactorFullSpheroid.h

@@ -20,7 +20,9 @@
 #include "IStochasticParameter.h"
 #include "MemberComplexFunctionIntegrator.h"
 
-//! Formfactor of a full spheroid
+//! @class FormFactorFullSpheroid
+//! @ingroup formfactors
+//! @brief The formfactor of a full spheroid.
 
 class BA_CORE_API_ FormFactorFullSpheroid : public IFormFactorBorn
 {