Merge branch 'master' of https://git.salome-platform.org/git/modules/hydro

[modules/hydro.git] / src / HYDROData / HYDROData_Zone.h

diff --git a/src/HYDROData/HYDROData_Zone.h b/src/HYDROData/HYDROData_Zone.h
index 3f95324ceb28e197b565e1f30b54817081b98232..cde3b789a8f0a2a7facef4709c4ea50a23d2e982 100644 (file)
--- a/src/HYDROData/HYDROData_Zone.h
+++ b/src/HYDROData/HYDROData_Zone.h
@@ -135,11 +135,13 @@ public:
   /**
    * Sets the reference object to resolve the conflict.
    * This object is used only in case of "Merge_Object" merge type.
+   * \param theObject the merge object
    */
   HYDRODATA_EXPORT virtual void SetMergeObject( const Handle(HYDROData_Entity)& theObject );
 
   /**
    * Returns the reference object to resolve the conflict.
+   * \return the merge object
    */
   HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetMergeObject() const;
 
@@ -150,11 +152,13 @@ public:
   
   /**
    * Add new one object for zone.
+   * \param theObject the object to add
    */
   HYDRODATA_EXPORT virtual bool AddObject( const Handle(HYDROData_Entity)& theObject );
 
   /**
    * Returns all objects of zone.
+   * \return the list of objects
    */
   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetObjects() const;
 
@@ -163,6 +167,10 @@ public:
    */
   HYDRODATA_EXPORT virtual void RemoveObjects();
 
+  /**
+   * Returns submersible flag.
+   * \return true if all objects of the zone is submersible
+   */
   HYDRODATA_EXPORT bool IsSubmersible() const;
 
 protected: