Tethrahedron, ripples, pyramid and prisms: consistent tooltips and doxygen comments.

Core/HardParticle/FormFactorPrism3.cpp

@@ -19,6 +19,9 @@
 #include "RealParameter.h"
 #include <iostream>
 
+//! Constructor of a prism with an equilaterial triangle base.
+//! @param base_edge: length of the base edge in nanometers
+//! @param height: height in nanometers
 FormFactorPrism3::FormFactorPrism3(double base_edge, double height)
     : FormFactorPolygonalPrism( height ), m_base_edge( base_edge )
 {

Core/HardParticle/FormFactorPrism6.cpp

@@ -18,6 +18,9 @@
 #include "Pyramid6.h"
 #include "RealParameter.h"
 
+//! Constructor of a prism with a regular hexagonal base.
+//! @param base_edge: length of the hexagonal base in nanometers
+//! @param height: height in nanometers
 FormFactorPrism6::FormFactorPrism6(double base_edge, double height)
     : FormFactorPolygonalPrism( height )
     , m_base_edge(base_edge)

Core/HardParticle/FormFactorPyramid.cpp

@@ -31,10 +31,10 @@ const PolyhedralTopology FormFactorPyramid::topology = {
         { { 4, 5, 6, 7 }, true  }  // TODO -> true
     }, false };
 
-//! @param base_edge of one side of the square base
-//! @param height    of the frustum
-//! @param alpha:    dihedral angle in radians between base and facet
-
+//! Constructor of a truncated pyramid with a square base
+//! @param base_edge: length of the square base in nanometers
+//! @param height: height of the pyramid in nanometers
+//! @param alpha: angle between the base and a side face in radians
 FormFactorPyramid::FormFactorPyramid(double base_edge, double height, double alpha)
     : FormFactorPolyhedron()
     , m_base_edge(base_edge)

Core/HardParticle/FormFactorRipple1.cpp

@@ -22,6 +22,10 @@
 #include "RealParameter.h"
 #include "RippleCosine.h"
 
+//! @brief Constructor of cosine ripple.
+//! @param length: length of the rectangular base in nanometers
+//! @param width: width of the rectangular base in nanometers
+//! @param height: height of the ripple in nanometers
 FormFactorRipple1::FormFactorRipple1(double length, double width, double height)
     : m_length(length), m_width(width), m_height(height)
 {

Core/HardParticle/FormFactorRipple1.h

@@ -25,10 +25,6 @@
 class BA_CORE_API_ FormFactorRipple1 : public IFormFactorBorn
 {
 public:
-    //! @brief Ripple1 constructor
-    //! @param length of Ripple1
-    //! @param width of cosine cross section
-    //! @param height of cosine cross section
     FormFactorRipple1(double length, double width, double height);
 
     FormFactorRipple1* clone() const override final {

Core/HardParticle/FormFactorRipple2.cpp

@@ -20,6 +20,11 @@
 #include "RealParameter.h"
 #include "RippleSawtooth.h"
 
+//! @brief Constructor of a triangular ripple.
+//! @param length: length of the rectangular base in nanometers
+//! @param width: width of the rectangular base in nanometers
+//! @param height: height of the ripple in nanometers
+//! @param asymmetry: asymmetry length of the triangular profile in nanometers
 FormFactorRipple2::FormFactorRipple2(double length, double width, double height, double asymmetry)
     : m_length(length), m_width(width), m_height(height), m_d(asymmetry)
 {

Core/HardParticle/FormFactorRipple2.h

@@ -24,11 +24,6 @@
 class BA_CORE_API_ FormFactorRipple2 : public IFormFactorBorn
 {
 public:
-    //! @brief Ripple2 constructor
-    //! @param length of Ripple2
-    //! @param width of triangular cross section
-    //! @param height of triangular cross section
-    //! @param asymmetry length of triangular cross section
     FormFactorRipple2(double length, double width, double height, double asymmetry);
 
     FormFactorRipple2 *clone() const override final {

Core/HardParticle/FormFactorTetrahedron.cpp

@@ -31,10 +31,10 @@ const PolyhedralTopology FormFactorTetrahedron::topology = {
     }, false };
 
 
-//! @param base_edge of a side of the base
-//! @param height    of the frustum
-//! @param alpha:    dihedral angle in radians between base and facet
-
+//! Constructor of a truncated tethrahedron.
+//! @param base_edge: length of one edge of the equilateral triangular base in nanometers
+//! @param height: height of the tetrahedron in nanometers
+//! @param alpha: dihedral angle in radians between base and facet
 FormFactorTetrahedron::FormFactorTetrahedron(double base_edge, double height, double alpha)
     : FormFactorPolyhedron()
     , m_base_edge(base_edge)

GUI/coregui/Models/FormFactorItems.cpp

@@ -347,9 +347,9 @@ Prism3Item::Prism3Item()
 {
     setToolTip(QStringLiteral("Prism with an equilaterial triangle base"));
     addProperty(P_BASEEDGE, 10.0)
-        ->setToolTip(QStringLiteral("Length of the base edge in nm"));
+        ->setToolTip(QStringLiteral("Length of the base edge in nanometers"));
     addProperty(P_HEIGHT, 13.0)
-        ->setToolTip(QStringLiteral("Height in nm"));
+        ->setToolTip(QStringLiteral("Height in nanometers"));
 }
 
 std::unique_ptr<IFormFactor> Prism3Item::createFormFactor() const
@@ -370,9 +370,9 @@ Prism6Item::Prism6Item()
 {
     setToolTip(QStringLiteral("Prism with a regular hexagonal base"));
     addProperty(P_BASEEDGE, 5.0)
-        ->setToolTip(QStringLiteral("Length of the hexagonal base in nm"));
+        ->setToolTip(QStringLiteral("Length of the hexagonal base in nanometers"));
     addProperty(P_HEIGHT, 11.0)
-        ->setToolTip(QStringLiteral("Height in nm"));
+        ->setToolTip(QStringLiteral("Height in nanometers"));
 }
 
 std::unique_ptr<IFormFactor> Prism6Item::createFormFactor() const
@@ -394,11 +394,11 @@ PyramidItem::PyramidItem()
 {
     setToolTip(QStringLiteral("Truncated pyramid with a square base"));
     addProperty(P_BASEEDGE, 18.0)
-        ->setToolTip(QStringLiteral("Length of the square base in nm"));
+        ->setToolTip(QStringLiteral("Length of the square base in nanometers"));
     addProperty(P_HEIGHT, 13.0)
-        ->setToolTip(QStringLiteral("Height of the pyramid in nm"));
+        ->setToolTip(QStringLiteral("Height of the pyramid in nanometers"));
     addProperty(P_ALPHA, 60.0)->setToolTip(QStringLiteral(
-       "Angle between the base and the middle of the lateral faces in degrees"));
+       "angle between the base and a side face in degrees"));
 }
 
 std::unique_ptr<IFormFactor> PyramidItem::createFormFactor() const
@@ -421,11 +421,11 @@ Ripple1Item::Ripple1Item()
 {
     setToolTip(QStringLiteral("Particle with a cosine profile and a rectangular base"));
     addProperty(P_LENGTH, 27.0)
-        ->setToolTip(QStringLiteral("Length of the rectangular base in nm"));
+        ->setToolTip(QStringLiteral("Length of the rectangular base in nanometers"));
     addProperty(P_WIDTH, 20.0)
-        ->setToolTip(QStringLiteral("Width of the rectangular base in nm"));
+        ->setToolTip(QStringLiteral("Width of the rectangular base in nanometers"));
     addProperty(P_HEIGHT, 14.0)
-        ->setToolTip(QStringLiteral("Height of the ripple in nm"));
+        ->setToolTip(QStringLiteral("Height of the ripple in nanometers"));
 }
 
 std::unique_ptr<IFormFactor> Ripple1Item::createFormFactor() const
@@ -450,13 +450,13 @@ Ripple2Item::Ripple2Item()
     setToolTip(QStringLiteral(
         "Particle with an asymmetric triangle profile and a rectangular base"));
     addProperty(P_LENGTH, 36.0)
-        ->setToolTip(QStringLiteral("Length of the rectangular base in nm"));
+        ->setToolTip(QStringLiteral("Length of the rectangular base in nanometers"));
     addProperty(P_WIDTH, 25.0)
-        ->setToolTip(QStringLiteral("Width of the rectangular base in nm"));
+        ->setToolTip(QStringLiteral("Width of the rectangular base in nanometers"));
     addProperty(P_HEIGHT, 14.0)
-        ->setToolTip(QStringLiteral("Height of the ripple in nm"));
+        ->setToolTip(QStringLiteral("Height of the ripple in nanometers"));
     addProperty(P_ASYMMETRY, 3.0)
-        ->setToolTip(QStringLiteral("Asymmetry length of the triangular profile in nm"));
+        ->setToolTip(QStringLiteral("Asymmetry length of the triangular profile in nanometers"));
 }
 
 std::unique_ptr<IFormFactor> Ripple2Item::createFormFactor() const
@@ -478,14 +478,13 @@ const QString TetrahedronItem::P_ALPHA = QString::fromStdString(BornAgain::Alpha
 TetrahedronItem::TetrahedronItem()
     : FormFactorItem(Constants::TetrahedronType)
 {
-    setToolTip(QStringLiteral(
-        "Truncated polyhedron with equilateral triangle base and cropped side faces"));
-    addProperty(P_BASEEDGE, 15.0)
-        ->setToolTip(QStringLiteral("Side length of the base in nm"));
+    setToolTip(QStringLiteral("A truncated tethrahedron"));
+    addProperty(P_BASEEDGE, 15.0)->setToolTip(QStringLiteral(
+        "Length of one edge of the equilateral triangular base in nanometers"));
     addProperty(P_HEIGHT, 6.0)
-        ->setToolTip(QStringLiteral("Height of the tetrahedron in nm"));
+        ->setToolTip(QStringLiteral("Height of the tetrahedron in nanometers"));
     addProperty(P_ALPHA, 60.0)->setToolTip(QStringLiteral(
-        "Angle between the base and the middle of the side faces in degrees"));
+        "Dihedral angle in degrees between base and facet"));
 }
 
 std::unique_ptr<IFormFactor> TetrahedronItem::createFormFactor() const