correcting bugs but still exsitings

[blast.git] / ConnectionItem.h

diff --git a/ConnectionItem.h b/ConnectionItem.h
index 567a31d4e83edcb2b0252b5b33e21fca4761754f..867e8110d145e38c72484bac002ed7e61620f701 100644 (file)
--- a/ConnectionItem.h
+++ b/ConnectionItem.h
@@ -14,9 +14,9 @@ class InterfaceItem;
 using namespace std;
 using namespace Qt;
 
-/* NOTES :
+/*! \brief ConnectionItem class
 
-   A connection item represent a graphical link between two interface items.
+   A ConnectionItem represents a graphical link between two interface items.
    Even if it links two in/out interfaces, it is always oriented.
    The orientation depends on the type and direction of linked interfaces :
 
@@ -61,7 +61,19 @@ public:
   void setSelected(bool selected);
 
   void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
-  void setPathes();
+
+  /*!
+   * \brief setPath
+   * setPath() allows to compute the graphical shape of the ConnectionItem
+   * taking into account the position/direction of from and to interface items.
+   * Depending on their vlaue, it calls on of the dedicated methods.
+   *
+   * CAUTION: this method calls prepareGeometryChange() so that the scene
+   * can automatically updates and redraw the ConnectionItem. Thus, there is
+   * no need to call update() after the termination of this method.
+   *
+   */
+  void setPath();
   void addInterPoint(QPointF point);
 
   static int counter;