Dialog documentation.

--HG--
branch : develop

src/dialogs/dialogcutarc.h

@@ -35,17 +35,50 @@ namespace Ui {
 class DialogCutArc;
 }
 
+/**
+ * @brief The DialogCutArc class dialog for ToolCutArc.
+ */
 class DialogCutArc : public DialogTool
 {
     Q_OBJECT
 public:
+    /**
+     * @brief DialogCutArc create dialog.
+     * @param data container with data
+     * @param parent parent widget
+     */
     DialogCutArc(const VContainer *data, QWidget *parent = 0);
     ~DialogCutArc();
+    /**
+     * @brief getPointName return name point on arc
+     * @return name
+     */
     QString           getPointName() const {return pointName;}
+    /**
+     * @brief setPointName set name point on arc
+     * @param value name
+     */
     void              setPointName(const QString &value);
+    /**
+     * @brief getFormula return string with formula length
+     * @return formula
+     */
     QString           getFormula() const {return formula;}
+    /**
+     * @brief setFormula set string with formula length
+     * @param value string with formula
+     */
     void              setFormula(const QString &value);
+    /**
+     * @brief getArcId return id of arc
+     * @return id
+     */
     qint64            getArcId() const {return arcId;}
+    /**
+     * @brief setArcId set id of arc
+     * @param value id
+     * @param id don't show this id in list
+     */
     void              setArcId(const qint64 &value, const qint64 &id);
 public slots:
     /**
@@ -60,9 +93,21 @@ public slots:
     virtual void      DialogAccepted();
 private:
     Q_DISABLE_COPY(DialogCutArc)
+    /**
+     * @brief ui keeps information about user interface
+     */
     Ui::DialogCutArc  *ui;
+    /**
+     * @brief pointName name of created point
+     */
     QString           pointName;
+    /**
+     * @brief formula string with formula
+     */
     QString           formula;
+    /**
+     * @brief arcId keep id of arc
+     */
     qint64            arcId;
 };
 

src/dialogs/dialogcutspline.h

@@ -36,10 +36,18 @@ namespace Ui
     class DialogCutSpline;
 }
 
+/**
+ * @brief The DialogCutSpline class dialog for ToolCutSpline.
+ */
 class DialogCutSpline : public DialogTool
 {
     Q_OBJECT
 public:
+    /**
+     * @brief DialogCutSpline create dialog.
+     * @param data container with data
+     * @param parent parent widget
+     */
     DialogCutSpline(const VContainer *data, QWidget *parent = 0);
     ~DialogCutSpline();
     /**
@@ -86,9 +94,21 @@ public slots:
     virtual void      DialogAccepted();
 private:
     Q_DISABLE_COPY(DialogCutSpline)
+    /**
+     * @brief ui keeps information about user interface
+     */
     Ui::DialogCutSpline *ui;
+    /**
+     * @brief pointName name of created point
+     */
     QString           pointName;
+    /**
+     * @brief formula string with formula
+     */
     QString           formula;
+    /**
+     * @brief splineId keep id of spline
+     */
     qint64            splineId;
 };
 

src/dialogs/dialogcutsplinepath.h

@@ -36,10 +36,18 @@ namespace Ui
     class DialogCutSplinePath;
 }
 
+/**
+ * @brief The DialogCutSplinePath class dialog for ToolCutSplinePath.
+ */
 class DialogCutSplinePath : public DialogTool
 {
     Q_OBJECT
 public:
+    /**
+     * @brief DialogCutSplinePath create dialog.
+     * @param data container with data
+     * @param parent parent widget
+     */
     DialogCutSplinePath(const VContainer *data, QWidget *parent = 0);
     ~DialogCutSplinePath();
     /**
@@ -86,9 +94,21 @@ public slots:
     virtual void      DialogAccepted();
 private:
     Q_DISABLE_COPY(DialogCutSplinePath)
+    /**
+     * @brief ui keeps information about user interface
+     */
     Ui::DialogCutSplinePath *ui;
+    /**
+     * @brief pointName name of created point
+     */
     QString           pointName;
+    /**
+     * @brief formula string with formula
+     */
     QString           formula;
+    /**
+     * @brief splinePathId keep id of splinePath
+     */
     qint64            splinePathId;
 };
 

src/dialogs/dialogdetail.h

@@ -91,6 +91,9 @@ public slots:
      * @param row number of row
      */
     void             ObjectChanged(int row);
+    /**
+     * @brief DeleteItem delete item from list
+     */
     void             DeleteItem();
 private:
     /**

src/dialogs/dialogtool.h

@@ -276,10 +276,17 @@ protected:
     /**
      * @brief FillComboBoxSplines fill comboBox list of splines
      * @param box comboBox
-     * @param id don't show id+1 and id+2 in list
+     * @param id don't show id in list
+     * @param cut if set to ComboMode::CutSpline don't show id+1 and id+2
      */
     void             FillComboBoxSplines(QComboBox *box, const qint64 &id = 0,
                                          ComboMode::ComboBoxCutSpline cut = ComboMode::NoCutSpline)const;
+    /**
+     * @brief FillComboBoxSplinesPath
+     * @param box comboBox
+     * @param id don't show id in list
+     * @param cut if set to ComboMode::CutSpline don't show id+1 and id+2
+     */
     void             FillComboBoxSplinesPath(QComboBox *box, const qint64 &id = 0,
                                              ComboMode::ComboBoxCutSpline cut = ComboMode::NoCutSpline)const;
     /**
@@ -356,9 +363,18 @@ protected:
      * @param splineId save current spline id
      * @param value spline id
      * @param id don't show this id in list
+     * @param cut if set to ComboMode::CutSpline don't show id+1 and id+2
      */
     void             setCurrentSplineId(QComboBox *box, qint64 &splineId, const qint64 &value, const qint64 &id,
                                         ComboMode::ComboBoxCutSpline cut = ComboMode::NoCutSpline) const;
+    /**
+     * @brief setCurrentArcId
+     * @param box combobox
+     * @param arcId save current arc id
+     * @param value arc id
+     * @param id don't show this id in list
+     * @param cut if set to ComboMode::CutArc don't show id+1 and id+2
+     */
     void             setCurrentArcId(QComboBox *box, qint64 &arcId, const qint64 &value, const qint64 &id,
                                         ComboMode::ComboBoxCutArc cut = ComboMode::NoCutArc) const;
     /**
@@ -367,6 +383,7 @@ protected:
      * @param splinePathId save current splinePath id
      * @param value splinePath id
      * @param id don't show this id in list
+     * @param cut if set to ComboMode::CutSpline don't show id+1 and id+2
      */
     void             setCurrentSplinePathId(QComboBox *box, qint64 &splinePathId, const qint64 &value, const qint64 &id,
                                             ComboMode::ComboBoxCutSpline cut = ComboMode::NoCutSpline) const;
@@ -377,6 +394,11 @@ protected:
      */
     qint64           getCurrentObjectId(QComboBox *box) const;
 private:
+    /**
+     * @brief FillList fill combobox list
+     * @param box combobox
+     * @param list list with ids and names
+     */
     void             FillList(QComboBox *box, const QMap<QString, qint64> &list)const;
 };
 

src/dialogs/dialoguniondetails.h

@@ -36,15 +36,39 @@ namespace Ui
     class DialogUnionDetails;
 }
 
+/**
+ * @brief The DialogUnionDetails class dialog for ToolUnionDetails.
+ */
 class DialogUnionDetails : public DialogTool
 {
     Q_OBJECT
 public:
+    /**
+     * @brief DialogUnionDetails create dialog
+     * @param data container with data
+     * @param parent parent widget
+     */
     explicit DialogUnionDetails(const VContainer *data, QWidget *parent = 0);
              ~DialogUnionDetails();
+    /**
+     * @brief getD1 return id first detail
+     * @return id
+     */
     inline qint64    getD1() const {return d1;}
+    /**
+     * @brief getD2 return id second detail
+     * @return id
+     */
     inline qint64    getD2() const {return d2;}
+    /**
+     * @brief getIndexD1 return index edge first detail
+     * @return index
+     */
     inline ptrdiff_t getIndexD1() const {return indexD1;}
+    /**
+     * @brief getIndexD2 return index edge second detail
+     * @return index
+     */
     inline ptrdiff_t getIndexD2() const {return indexD2;}
 public slots:
     /**
@@ -59,16 +83,56 @@ public slots:
     virtual void     DialogAccepted();
 private:
     Q_DISABLE_COPY(DialogUnionDetails)
+    /**
+     * @brief ui keeps information about user interface
+     */
     Ui::DialogUnionDetails *ui;
+    /**
+     * @brief indexD1 index edge first detail
+     */
     ptrdiff_t        indexD1;
+    /**
+     * @brief indexD2 index edge second detail
+     */
     ptrdiff_t        indexD2;
+    /**
+     * @brief d1 id first detail
+     */
     qint64           d1;
+    /**
+     * @brief d2 id second detail
+     */
     qint64           d2;
-    qint32           numberD; // number of detail, what we already have
+    /**
-    qint32           numberP; // number of points, what we already have
+     * @brief numberD number of detail, what we already have
+     */
+    qint32           numberD;
+    /**
+     * @brief numberP number of points, what we already have
+     */
+    qint32           numberP;
+    /**
+     * @brief p1 id first point of detail
+     */
     qint64           p1;
+    /**
+     * @brief p2 id second point of detail
+     */
     qint64           p2;
+    /**
+     * @brief CheckObject check if detail contain this id
+     * @param id id of item
+     * @param idDetail detail id
+     * @return true if contain
+     */
     bool             CheckObject(const qint64 &id, const qint64 &idDetail) const;
+    /**
+     * @brief ChoosedDetail help save information about detail and points on detail
+     * @param id id selected object
+     * @param type type selected object
+     * @param idDetail id detail
+     * @param index index of edge
+     */
     void             ChoosedDetail(const qint64 &id, const Scene::Scenes &type, qint64 &idDetail, ptrdiff_t &index);
 };