The flushCreated/flushUpdated are obsolete and nobody uses them.

[modules/shaper.git] / src / ModuleBase / ModuleBase_ViewerPrs.h

diff --git a/src/ModuleBase/ModuleBase_ViewerPrs.h b/src/ModuleBase/ModuleBase_ViewerPrs.h
index b9bcb2b9d5c18c4a2f61a00dd822e5f70d36ccba..cd8751fe7e69a9f425f5d61564502afb51cc851a 100644 (file)
--- a/src/ModuleBase/ModuleBase_ViewerPrs.h
+++ b/src/ModuleBase/ModuleBase_ViewerPrs.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_ViewerPrs.h
 // Created:     20 Apr 2014
 // Author:      Natalia ERMOLAEVA
@@ -15,7 +17,7 @@
 #include <ModelAPI_Result.h>
 
 /**\class ModuleBase_ViewerPrs
- * \ingroup Module base
+ * \ingroup GUI
  * \brief Presentation. Provides container to have feature, shape and/or selection owner.
  */
 class ModuleBase_ViewerPrs
@@ -27,7 +29,7 @@ class ModuleBase_ViewerPrs
   }
 
   /// Constructor
-  /// \param theFeature a model feature
+  /// \param theResult an object
   /// \param theShape a viewer shape
   /// \param theOwner a selection owner
   ModuleBase_ViewerPrs(ObjectPtr theResult, const TopoDS_Shape& theShape,
@@ -43,8 +45,8 @@ class ModuleBase_ViewerPrs
   {
   }
 
-  /// Sets the feature.
-  /// \param theFeature a feature instance
+  /// Sets the object.
+  /// \param theResult an object instance
   void setFeature(ObjectPtr theResult)
   {
     myResult = theResult;
@@ -57,8 +59,8 @@ class ModuleBase_ViewerPrs
     return myResult;
   }
 
-  /// Returns the presentation owner
-  /// \param the owner
+  /// Set the presentation owner
+  /// \param theOwner an owner to set
   void setOwner(Handle_SelectMgr_EntityOwner theOwner)
   {
     myOwner = theOwner;
@@ -85,16 +87,21 @@ class ModuleBase_ViewerPrs
     return myShape;
   }
 
+  /// Set interactive object
+  /// \param theIO an interactive object
   void setInteractive(const Handle(AIS_InteractiveObject)& theIO)
   {
     myInteractive = theIO;
   }
 
+  /// Returns interactive object if it is installed
   Handle(AIS_InteractiveObject) interactive() const
   {
     return myInteractive;
   }
 
+  /// Returns True if the current object is equal to the given one
+  /// \param thePrs an object to compare
   bool operator==(const ModuleBase_ViewerPrs& thePrs)
   {
     bool aResult = (myResult.get() == thePrs.object().get());
@@ -108,7 +115,7 @@ class ModuleBase_ViewerPrs
   ObjectPtr myResult;  /// the feature
   Handle(SelectMgr_EntityOwner) myOwner;  /// the selection owner
   TopoDS_Shape myShape;  /// the shape
-  Handle(AIS_InteractiveObject) myInteractive;
+  Handle(AIS_InteractiveObject) myInteractive;  /// interactive object
 };
 
 #endif