ba3d: doxy comments, and flatten directory hierarchy (-> ba3d/mesh)

GUI/ba3d/def.h

@@ -57,7 +57,7 @@ Vector3D operator*(const Vector3D&, float);
 Vector3D operator+(const Vector3D&, const Vector3D&);
 Vector3D operator-(const Vector3D&, const Vector3D&);
 
-// range of float
+//! Range of float
 struct Range {
     float min, max;
     Range(float, float);
@@ -66,7 +66,7 @@ struct Range {
     float mid() const;
 };
 
-// range of coordinates
+//! Range of coordinates
 struct VectorRange {
     Range x, y, z;
     VectorRange(Range, Range, Range);

GUI/ba3d/model/geometry/box.cpp → GUI/ba3d/mesh/box.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/box.cpp
+//! @file      GUI/ba3d/mesh/box.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry/column.cpp → GUI/ba3d/mesh/column.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/column.cpp
+//! @file      GUI/ba3d/mesh/column.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry/cuboctahedron.cpp → GUI/ba3d/mesh/cuboctahedron.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/cuboctahedron.cpp
+//! @file      GUI/ba3d/mesh/cuboctahedron.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry/dodecahedron.cpp → GUI/ba3d/mesh/dodecahedron.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/dodecahedron.cpp
+//! @file      GUI/ba3d/mesh/dodecahedron.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry/icosahedron.cpp → GUI/ba3d/mesh/icosahedron.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/icosahedron.cpp
+//! @file      GUI/ba3d/mesh/icosahedron.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry/plane.cpp → GUI/ba3d/mesh/plane.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/plane.cpp
+//! @file      GUI/ba3d/mesh/plane.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry/ripple.cpp → GUI/ba3d/mesh/ripple.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/ripple.cpp
+//! @file      GUI/ba3d/mesh/ripple.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry/sphere.cpp → GUI/ba3d/mesh/sphere.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/sphere.cpp
+//! @file      GUI/ba3d/mesh/sphere.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry/truncbox.cpp → GUI/ba3d/mesh/truncbox.cpp

@@ -2,7 +2,7 @@
 //
 //  BornAgain: simulate and fit reflection and scattering
 //
-//! @file      GUI/ba3d/model/geometry/truncbox.cpp
+//! @file      GUI/ba3d/mesh/truncbox.cpp
 //! @brief     Implements utility functions in ba3d namespace
 //!
 //! @homepage  http://www.bornagainproject.org

GUI/ba3d/model/geometry_inc.h

@@ -34,7 +34,7 @@ extern const float DodecahedronL2R;
 
 namespace GeometricID {
 
-// Enum id for basic shapes
+//! Enum id for basic shapes
 enum class BaseShape {
     Plane,
     Box,
@@ -47,7 +47,7 @@ enum class BaseShape {
     Ripple
 };
 
-// Real shapes will be parameterized by BaseShape enum and possibly two floats
+//! Real shapes will be parameterized by BaseShape enum and possibly two floats
 struct Key {
     Key(BaseShape, float = 0.0f, float = 0.0f, float = 0.0f);
 
@@ -57,7 +57,7 @@ struct Key {
     float p1, p2, p3;
 };
 
-// Hash functor for Key objects
+//! Hash functor for Key objects
 struct KeyHash {
     std::size_t operator()(const Key& key) const noexcept;
 };

GUI/ba3d/model/layer.h

@@ -19,7 +19,7 @@
 
 namespace GUI::RealSpace {
 
-// particle layer: a transparent box
+//! Particle layer: a transparent box
 class Layer : public Object {
 public:
     Layer(VectorRange);

GUI/ba3d/model/model.h

@@ -39,17 +39,17 @@ public:
 
     static Particles::Particle* newParticle(Particles::EShape k, float R);
 
-    void add(Object*);      // add an opaque object, the model takes ownership
-    void addBlend(Object*); // add a transparent object, the model takes ownership
-    void rem(Object*);      // removes an object, the caller becomes responsible
+    void add(Object*);      //!< add an opaque object, the model takes ownership
+    void addBlend(Object*); //!< add a transparent object, the model takes ownership
+    void rem(Object*);      //!< removes an object, the caller becomes responsible
 
-    void releaseGeometries(); // may be called any time
+    void releaseGeometries(); //!< may be called any time
 
     bool modelIsEmpty();
 
     virtual void cameraUpdated(Camera const&) {}
 
-    Camera::Position defCamPos; // default camera params
+    Camera::Position defCamPos; //!< default camera params
 
 signals:
     void updated(bool withEye);

GUI/ba3d/model/object.h

@@ -24,6 +24,7 @@ namespace GUI::RealSpace {
 class Model;
 class Canvas;
 
+//! A geometric object
 class Object {
     friend class Model;
 

GUI/ba3d/model/particles.h

@@ -77,7 +77,6 @@ public:
 };
 
 //------------------------------------------------------------------------------
-// follow BornAgain manual, chapter 11, Particle form factors
 
 class FullSphere : public Particle {
 public:

GUI/ba3d/view/camera.h

@@ -45,8 +45,8 @@ public:
         Position interpolateTo(const Position&, float) const;
     };
 
-    void lookAt(const Position&);       // camera position for 3D object
-    void lookAt3DAxes(const Position&); // camera position for 3D axes
+    void lookAt(const Position&);       //!< camera position for 3D object
+    void lookAt3DAxes(const Position&); //!< camera position for 3D axes
 
     const Position& getPos() const { return pos; }
     const Position& getPos3DAxes() const { return pos3DAxes; }