DistanceMap & History group comments reworked in doxygen format (#148)

Author: ABSitf

source/MRMesh/MRChangeMeshAction.h

@@ -8,13 +8,16 @@
 namespace MR
 {
 
-// Undo action for ObjectMesh mesh change
+/// \defgroup HistoryGroup History group
+/// \{
+
+/// Undo action for ObjectMesh mesh change
 class ChangeMeshAction : public HistoryAction
 {
 public:
     using Obj = ObjectMesh;
 
-    // use this constructor to remember object's mesh before making any changes in it
+    /// use this constructor to remember object's mesh before making any changes in it
     ChangeMeshAction( std::string name, const std::shared_ptr<ObjectMesh>& obj ) :
         objMesh_{ obj },
         name_{ std::move( name ) }
@@ -57,13 +60,13 @@ class ChangeMeshAction : public HistoryAction
     std::string name_;
 };
 
-// Undo action for ObjectMesh points only (not topology) change
+/// Undo action for ObjectMesh points only (not topology) change
 class ChangeMeshPointsAction : public HistoryAction
 {
 public:
     using Obj = ObjectMesh;
 
-    // use this constructor to remember object's mesh points before making any changes in it
+    /// use this constructor to remember object's mesh points before making any changes in it
     ChangeMeshPointsAction( std::string name, const std::shared_ptr<ObjectMesh>& obj ) :
         objMesh_{ obj },
         name_{ std::move( name ) }
@@ -109,13 +112,13 @@ class ChangeMeshPointsAction : public HistoryAction
     std::string name_;
 };
 
-// Undo action for ObjectMesh topology only (not points) change
+/// Undo action for ObjectMesh topology only (not points) change
 class ChangeMeshTopologyAction : public HistoryAction
 {
 public:
     using Obj = ObjectMesh;
 
-    // use this constructor to remember object's mesh points before making any changes in it
+    /// use this constructor to remember object's mesh points before making any changes in it
     ChangeMeshTopologyAction( std::string name, const std::shared_ptr<ObjectMesh>& obj ) :
         objMesh_{ obj },
         name_{ std::move( name ) }
@@ -161,4 +164,6 @@ class ChangeMeshTopologyAction : public HistoryAction
     std::string name_;
 };
 
+/// \}
+
 } // namespace MR

source/MRMesh/MRChangeNameAction.h

@@ -8,11 +8,12 @@
 namespace MR
 {
 
-// This action to undo/redo the change of object name
+/// This action to undo/redo the change of object name
+/// \ingroup HistoryGroup
 class ChangeNameAction : public HistoryAction
 {
 public:
-    // construct before giving new name to the object
+    /// construct before giving new name to the object
     ChangeNameAction( const std::string& actionName, std::shared_ptr<Object> obj ) :
         obj_{ std::move( obj ) },
         actionName_{ actionName }
@@ -47,4 +48,4 @@ class ChangeNameAction : public HistoryAction
     std::string actionName_;
 };
 
-} //namespace MR
+} // namespace MR

source/MRMesh/MRChangeObjectAction.h

@@ -8,10 +8,12 @@
 namespace MR
 {
 
+/// History action for object change
+/// \ingroup HistoryGroup
 class ChangeObjectAction : public HistoryAction
 {
 public:
-    // Constructed from original Object
+    /// Constructed from original Object
     ChangeObjectAction( const std::string& name, const std::shared_ptr<Object>& obj ):
         obj_{ obj },
         name_{name}

source/MRMesh/MRChangePointCloudAction.h

@@ -9,13 +9,14 @@
 namespace MR
 {
 
-// Undo action for ObjectMesh mesh change
+/// Undo action for ObjectMesh mesh change
+/// \ingroup HistoryGroup
 class ChangePointCloudAction : public HistoryAction
 {
 public:
     using Obj = ObjectPoints;
 
-    // use this constructor to remember object's point cloud before making any changes in it
+    /// use this constructor to remember object's point cloud before making any changes in it
     ChangePointCloudAction( std::string name, const std::shared_ptr<ObjectPoints>& obj ) :
         objPoints_{ obj },
         name_{ std::move( name ) }

source/MRMesh/MRChangeSceneAction.h

@@ -7,6 +7,8 @@
 namespace MR
 {
 
+/// Change scene action
+/// \ingroup HistoryGroup
 class MRMESH_CLASS ChangeSceneAction : public HistoryAction
 {
 public:
@@ -15,7 +17,7 @@ class MRMESH_CLASS ChangeSceneAction : public HistoryAction
         AddObject,
         RemoveObject
     };
-    // Constructed before removal or addiction
+    /// Constructed before removal or addiction
     MRMESH_API ChangeSceneAction( const std::string& name, const std::shared_ptr<Object>& obj, Type type );
 
     virtual std::string name() const override { return name_; }
@@ -25,11 +27,11 @@ class MRMESH_CLASS ChangeSceneAction : public HistoryAction
     [[nodiscard]] MRMESH_API virtual size_t heapBytes() const override;
 
 private:
-    // updates parent and next child if it was not preset before
+    /// updates parent and next child if it was not preset before
     void updateParent_();
 
     Object* parent_{ nullptr };
-    std::shared_ptr<Object> nextObj_; // next child of parent (needed to insert child to correct place of tree)
+    std::shared_ptr<Object> nextObj_; ///< next child of parent (needed to insert child to correct place of tree)
     std::shared_ptr<Object> obj_;
     std::string name_;
     Type type_;

source/MRMesh/MRChangeSceneObjectsOrder.h

@@ -7,10 +7,12 @@
 namespace MR
 {
 
-class MRMESH_CLASS ChangeSceneObjectsOrder : public HistoryAction
+/// History action for scene objects order change
+/// \ingroup HistoryGroup
+class ChangeSceneObjectsOrder : public HistoryAction
 {
 public:
-    // Constructed before change order
+    /// Constructed before change order
     ChangeSceneObjectsOrder( const std::string& name, const std::shared_ptr<Object>& obj ) :
         obj_( obj ),
         name_( name )

source/MRMesh/MRChangeSelectionAction.h

@@ -6,13 +6,16 @@
 namespace MR
 {
 
-// Undo action for ObjectMesh face selection
+/// \addtogroup HistoryGroup
+/// \{
+
+/// Undo action for ObjectMesh face selection
 class ChangeMeshFaceSelectionAction : public HistoryAction
 {
 public:
     using Obj = ObjectMesh;
 
-    // use this constructor to remember object's face selection before making any changes in it
+    /// use this constructor to remember object's face selection before making any changes in it
     ChangeMeshFaceSelectionAction( const std::string& name, const std::shared_ptr<ObjectMesh>& objMesh ):
         name_{name},
         objMesh_{objMesh}
@@ -35,7 +38,7 @@ class ChangeMeshFaceSelectionAction : public HistoryAction
 
     const FaceBitSet & selection() const { return selection_; }
 
-    // empty because set dirty is inside selectFaces
+    /// empty because set dirty is inside selectFaces
     static void setObjectDirty( const std::shared_ptr<ObjectMesh>& ) {}
 
     [[nodiscard]] virtual size_t heapBytes() const override
@@ -49,13 +52,13 @@ class ChangeMeshFaceSelectionAction : public HistoryAction
     FaceBitSet selection_;
 };
 
-// Undo action for ObjectMesh edge selection
+/// Undo action for ObjectMesh edge selection
 class ChangeMeshEdgeSelectionAction : public HistoryAction
 {
 public:
     using Obj = ObjectMesh;
 
-    // use this constructor to remember object's edge selection before making any changes in it
+    /// use this constructor to remember object's edge selection before making any changes in it
     ChangeMeshEdgeSelectionAction( const std::string& name, const std::shared_ptr<ObjectMesh>& objMesh ) :
         name_{ name },
         objMesh_{ objMesh }
@@ -78,7 +81,7 @@ class ChangeMeshEdgeSelectionAction : public HistoryAction
 
     const UndirectedEdgeBitSet & selection() const { return selection_; }
 
-    // empty because set dirty is inside selectEdges
+    /// empty because set dirty is inside selectEdges
     static void setObjectDirty( const std::shared_ptr<ObjectMesh>& ) {}
 
     [[nodiscard]] virtual size_t heapBytes() const override
@@ -92,13 +95,13 @@ class ChangeMeshEdgeSelectionAction : public HistoryAction
     UndirectedEdgeBitSet selection_;
 };
 
-// Undo action for ObjectMesh creases
+/// Undo action for ObjectMesh creases
 class ChangeMeshCreasesAction : public HistoryAction
 {
 public:
     using Obj = ObjectMesh;
 
-    // use this constructor to remember object's creases before making any changes in it
+    /// use this constructor to remember object's creases before making any changes in it
     ChangeMeshCreasesAction( const std::string& name, const std::shared_ptr<ObjectMesh>& objMesh ) :
         name_{ name },
         objMesh_{ objMesh }
@@ -121,7 +124,7 @@ class ChangeMeshCreasesAction : public HistoryAction
 
     const UndirectedEdgeBitSet & creases() const { return creases_; }
 
-    // empty because set dirty is inside setCreases
+    /// empty because set dirty is inside setCreases
     static void setObjectDirty( const std::shared_ptr<ObjectMesh>& ) {}
 
     [[nodiscard]] virtual size_t heapBytes() const override
@@ -135,13 +138,13 @@ class ChangeMeshCreasesAction : public HistoryAction
     UndirectedEdgeBitSet creases_;
 };
 
-// Undo action for ObjectPoints point selection
+/// Undo action for ObjectPoints point selection
 class ChangePointPointSelectionAction : public HistoryAction
 {
 public:
     using Obj = ObjectPoints;
 
-    // use this constructor to remember object's vertex selection before making any changes in it
+    /// use this constructor to remember object's vertex selection before making any changes in it
     ChangePointPointSelectionAction( const std::string& name, const std::shared_ptr<ObjectPoints>& objPoints ) :
         name_{ name },
         objPoints_{ objPoints }
@@ -164,7 +167,7 @@ class ChangePointPointSelectionAction : public HistoryAction
 
     const VertBitSet& selection() const { return selection_; }
 
-    // empty because set dirty is inside selectPoints
+    /// empty because set dirty is inside selectPoints
     static void setObjectDirty( const std::shared_ptr<ObjectPoints>& )
     {}
 
@@ -178,4 +181,7 @@ class ChangePointPointSelectionAction : public HistoryAction
     std::shared_ptr<ObjectPoints> objPoints_;
     VertBitSet selection_;
 };
-}
+
+/// \}
+
+}

source/MRMesh/MRChangeXfAction.h

@@ -7,10 +7,12 @@
 namespace MR
 {
 
+/// History action for xf change
+/// \ingroup HistoryGroup
 class ChangeXfAction : public HistoryAction
 {
 public:
-    // Constructed from original obj
+    /// Constructed from original obj
     ChangeXfAction( const std::string& name, const std::shared_ptr<Object>& obj ) :
         obj_{ obj },
         xf_{ obj->xf() },
@@ -42,4 +44,5 @@ class ChangeXfAction : public HistoryAction
     AffineXf3f xf_;
     std::string name_;
 };
-}
+
+}

source/MRMesh/MRCombinedHistoryAction.h

@@ -6,10 +6,12 @@
 namespace MR
 {
 
+/// History action for combine some history actions
+/// \ingroup HistoryGroup
 class MRMESH_CLASS CombinedHistoryAction : public HistoryAction
 {
 public:
-    // Will call action() for each actions in given order (undo in reverse, redo in forward)
+    /// Will call action() for each actions in given order (undo in reverse, redo in forward)
     MRMESH_API CombinedHistoryAction( const std::string& name, const std::vector<std::shared_ptr<HistoryAction>>& actions );
 
     virtual std::string name() const override