copy edit

Core/Correlations/IPeakShape.cpp

@@ -76,7 +76,7 @@ double Cauchy3D(double q2, double domainsize)
 } // namespace
 
 // ************************************************************************** //
-// class IPeakShape
+// interface IPeakShape
 // ************************************************************************** //
 
 IPeakShape::IPeakShape(const NodeMeta& meta, const std::vector<double>& PValues)

Core/Correlations/IPeakShape.h

@@ -62,7 +62,7 @@ private:
     double m_domainsize;
 };
 
-//! Class that implements an isotropic Lorentzian peak shape of a Bragg peak.
+//! An isotropic Lorentzian peak shape of a Bragg peak.
 //!
 //! @ingroup samples_internal
 
@@ -84,7 +84,7 @@ private:
     double m_domainsize;
 };
 
-//! Class that implements a peak shape that is Gaussian in the radial direction and
+//! A peak shape that is Gaussian in the radial direction and
 //! uses the Mises-Fisher distribution in the angular direction.
 //!
 //! @ingroup samples_internal
@@ -109,8 +109,8 @@ private:
     double m_kappa;
 };
 
-//! Class that implements a peak shape that is Lorentzian in the radial direction and
-//! uses the Mises-Fisher distribution in the angular direction.
+//! A peak shape that is Lorentzian in the radial direction and uses the
+//! Mises-Fisher distribution in the angular direction.
 //!
 //! @ingroup samples_internal
 
@@ -134,9 +134,8 @@ private:
     double m_kappa;
 };
 
-//! Class that implements a peak shape that is Gaussian in the radial direction and a
-//! convolution of a Mises-Fisher distribution with a Mises distribution on the
-//! two-sphere
+//! A peak shape that is Gaussian in the radial direction and a convolution of a
+//! Mises-Fisher distribution with a Mises distribution on the two-sphere.
 //!
 //! @ingroup samples_internal
 
@@ -156,17 +155,17 @@ public:
     bool angularDisorder() const override { return true; }
 
 private:
-    double integrand(double phi) const;
     double m_max_intensity;
     double m_radial_size;
     kvector_t m_zenith;
     double m_kappa_1, m_kappa_2;
+
+    double integrand(double phi) const;
     mutable double m_theta, m_phi;
     mutable kvector_t m_ux, m_uy, m_up;
 };
 
-//! Class that implements a peak shape that is a convolution of a Mises-Fisher distribution
-//! with a 3d Gaussian
+//! A peak shape that is a convolution of a Mises-Fisher distribution with a 3d Gaussian.
 //!
 //! @ingroup samples_internal
 
@@ -185,11 +184,12 @@ public:
     bool angularDisorder() const override { return true; }
 
 private:
-    double integrand(double phi) const;
     double m_max_intensity;
     double m_radial_size;
     kvector_t m_zenith;
     double m_kappa;
+
+    double integrand(double phi) const;
     mutable double m_theta, m_phi, m_qr;
     mutable kvector_t m_ux, m_uy, m_p;
 };

Core/Lattice/Lattice2D.cpp

@@ -18,6 +18,10 @@
 #include "Core/Parametrization/RealParameter.h"
 #include <cmath>
 
+// ************************************************************************** //
+// class Lattice2D
+// ************************************************************************** //
+
 Lattice2D::Lattice2D(const NodeMeta& meta, const std::vector<double>& PValues)
     : INode(meta, PValues)
 {
@@ -57,7 +61,9 @@ void Lattice2D::setRotationEnabled(bool enabled) // TODO ASAP replace by generic
     }
 }
 
-// --------------------------------------------------------------------------------------------- //
+// ************************************************************************** //
+// class BasicLattice
+// ************************************************************************** //
 
 BasicLattice::BasicLattice(double length1, double length2, double angle, double xi)
     : Lattice2D(xi), m_length1(length1), m_length2(length2), m_angle(angle)
@@ -82,7 +88,9 @@ double BasicLattice::unitCellArea() const
     return std::abs(m_length1 * m_length2 * std::sin(m_angle));
 }
 
-// --------------------------------------------------------------------------------------------- //
+// ************************************************************************** //
+// class SquareLattice
+// ************************************************************************** //
 
 SquareLattice::SquareLattice(double length, double xi) : Lattice2D(xi), m_length(length)
 {
@@ -109,7 +117,9 @@ double SquareLattice::unitCellArea() const
     return std::abs(m_length * m_length);
 }
 
-// --------------------------------------------------------------------------------------------- //
+// ************************************************************************** //
+// class HexagonalLattice
+// ************************************************************************** //
 
 HexagonalLattice::HexagonalLattice(double length, double xi) : Lattice2D(xi), m_length(length)
 {