From 9a920968535ca07061f3182d60a7da18bc12f33b Mon Sep 17 00:00:00 2001 From: dismine Date: Fri, 24 Jan 2014 18:10:53 +0200 Subject: [PATCH] Documentation for VToolAlongLine class. --HG-- branch : develop --- src/tools/drawTools/vtoolalongline.h | 69 ++++++++++--------- src/tools/drawTools/vtoolarc.h | 8 +-- src/tools/drawTools/vtoolbisector.h | 16 ++--- src/tools/drawTools/vtoolcutspline.h | 10 +-- src/tools/drawTools/vtoolcutsplinepath.h | 10 +-- src/tools/drawTools/vtoolendline.h | 14 ++-- src/tools/drawTools/vtoolheight.h | 14 ++-- src/tools/drawTools/vtoolline.h | 8 +-- src/tools/drawTools/vtoollineintersect.h | 12 ++-- src/tools/drawTools/vtoollinepoint.h | 4 +- src/tools/drawTools/vtoolnormal.h | 16 ++--- src/tools/drawTools/vtoolpoint.h | 6 +- src/tools/drawTools/vtoolpointofcontact.h | 12 ++-- .../drawTools/vtoolpointofintersection.h | 10 +-- src/tools/drawTools/vtoolshoulderpoint.h | 16 ++--- src/tools/drawTools/vtoolsinglepoint.h | 2 +- src/tools/drawTools/vtoolspline.h | 8 +-- src/tools/drawTools/vtoolsplinepath.h | 8 +-- src/tools/drawTools/vtooltriangle.h | 10 +-- src/tools/nodeDetails/vnodearc.h | 4 +- src/tools/nodeDetails/vnodepoint.h | 8 +-- src/tools/nodeDetails/vnodespline.h | 4 +- src/tools/nodeDetails/vnodesplinepath.h | 4 +- src/tools/vtooluniondetails.h | 10 --- src/widgets/vmaingraphicsscene.h | 4 +- src/widgets/vmaingraphicsview.h | 2 +- src/widgets/vsimplespline.h | 2 +- src/xml/vdomdocument.h | 20 +++--- 28 files changed, 151 insertions(+), 160 deletions(-) diff --git a/src/tools/drawTools/vtoolalongline.h b/src/tools/drawTools/vtoolalongline.h index 44f9fc9a4..c802760bd 100644 --- a/src/tools/drawTools/vtoolalongline.h +++ b/src/tools/drawTools/vtoolalongline.h @@ -33,23 +33,23 @@ #include "../../dialogs/dialogalongline.h" /** - * @brief The VToolAlongLine class + * @brief The VToolAlongLine class tool for creation point along line. */ class VToolAlongLine : public VToolLinePoint { Q_OBJECT public: /** - * @brief VToolAlongLine - * @param doc dom document container - * @param data container with variables - * @param id object id in container - * @param formula - * @param firstPointId - * @param secondPointId - * @param typeLine + * @brief VToolAlongLine constuctor. + * @param doc dom document container. + * @param data container with variables. + * @param id object id in container. + * @param formula string with length formula. + * @param firstPointId id first point of line. + * @param secondPointId id second point of line. + * @param typeLine line type. line type. * @param typeCreation way we create this tool. - * @param parent parent object + * @param parent parent object. */ VToolAlongLine(VDomDocument *doc, VContainer *data, qint64 id, const QString &formula, const qint64 &firstPointId, const qint64 &secondPointId, const QString &typeLine, @@ -59,37 +59,34 @@ public: */ virtual void setDialog(); /** - * @brief Create - * @param dialog + * @brief Create help create tool form GUI. + * @param dialog dialog options. * @param scene pointer to scene. - * @param doc dom document container - * @param data container with variables + * @param doc dom document container. + * @param data container with variables. */ static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool. * @param _id tool id, 0 if tool doesn't exist yet. - * @param pointName - * @param typeLine - * @param formula - * @param firstPointId - * @param secondPointId - * @param mx - * @param my + * @param pointName point name. + * @param typeLine line type. + * @param formula string with length formula. + * @param firstPointId id first point of line. + * @param secondPointId id second point of line. + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. - * @param doc dom document container - * @param data container with variables - * @param parse + * @param doc dom document container. + * @param data container with variables. + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &pointName, const QString &typeLine, const QString &formula, const qint64 &firstPointId, const qint64 &secondPointId, const qreal &mx, const qreal &my, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data, const Document::Documents &parse, const Tool::Sources &typeCreation); - /** - * @brief ToolType - */ static const QString ToolType; public slots: /** @@ -98,19 +95,23 @@ public slots: virtual void FullUpdateFromFile(); /** * @brief FullUpdateFromGui refresh tool data from change options. - * @param result + * @param result result working dialog. */ virtual void FullUpdateFromGui(int result); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); + /** + * @brief ShowContextMenu handle context menu event. + * @param event context menu event. + */ virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); protected: /** - * @brief contextMenuEvent - * @param event + * @brief contextMenuEvent handle context menu event. + * @param event context menu event. */ virtual void contextMenuEvent ( QGraphicsSceneContextMenuEvent * event ); /** @@ -127,11 +128,11 @@ protected: virtual void RemoveReferens(); private: /** - * @brief secondPointId + * @brief secondPointId id second point of line. */ qint64 secondPointId; /** - * @brief dialogAlongLine + * @brief dialogAlongLine dialog. */ QSharedPointer dialogAlongLine; }; diff --git a/src/tools/drawTools/vtoolarc.h b/src/tools/drawTools/vtoolarc.h index 8557388b0..a13736cd0 100644 --- a/src/tools/drawTools/vtoolarc.h +++ b/src/tools/drawTools/vtoolarc.h @@ -56,7 +56,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -65,7 +65,7 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param center * @param radius @@ -74,7 +74,7 @@ public: * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const qint64 ¢er, const QString &radius, const QString &f1, @@ -112,7 +112,7 @@ public slots: virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); protected: diff --git a/src/tools/drawTools/vtoolbisector.h b/src/tools/drawTools/vtoolbisector.h index 0822d03d9..65ae218cd 100644 --- a/src/tools/drawTools/vtoolbisector.h +++ b/src/tools/drawTools/vtoolbisector.h @@ -43,7 +43,7 @@ public: * @param doc dom document container * @param data container with variables * @param id object id in container - * @param typeLine + * @param typeLine line type. * @param formula * @param firstPointId * @param secondPointId @@ -70,7 +70,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -79,20 +79,20 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param formula * @param firstPointId * @param secondPointId * @param thirdPointId - * @param typeLine + * @param typeLine line type. * @param pointName - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &formula, const qint64 &firstPointId, @@ -116,7 +116,7 @@ public slots: virtual void FullUpdateFromGui(int result); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); diff --git a/src/tools/drawTools/vtoolcutspline.h b/src/tools/drawTools/vtoolcutspline.h index 9a1185884..9efbb001a 100644 --- a/src/tools/drawTools/vtoolcutspline.h +++ b/src/tools/drawTools/vtoolcutspline.h @@ -58,7 +58,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -67,17 +67,17 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param pointName * @param formula * @param splineId - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &pointName, diff --git a/src/tools/drawTools/vtoolcutsplinepath.h b/src/tools/drawTools/vtoolcutsplinepath.h index eb244b655..6cf611a9a 100644 --- a/src/tools/drawTools/vtoolcutsplinepath.h +++ b/src/tools/drawTools/vtoolcutsplinepath.h @@ -48,7 +48,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -57,17 +57,17 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param pointName * @param formula * @param splineId - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &pointName, const QString &formula, diff --git a/src/tools/drawTools/vtoolendline.h b/src/tools/drawTools/vtoolendline.h index c38144e3e..fa1a13942 100644 --- a/src/tools/drawTools/vtoolendline.h +++ b/src/tools/drawTools/vtoolendline.h @@ -44,7 +44,7 @@ public: * @param doc dom document container * @param data container with variables * @param id object id in container - * @param typeLine + * @param typeLine line type. * @param formula * @param angle * @param basePointId @@ -59,7 +59,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -68,19 +68,19 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param pointName - * @param typeLine + * @param typeLine line type. * @param formula * @param angle * @param basePointId - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &pointName, const QString &typeLine, diff --git a/src/tools/drawTools/vtoolheight.h b/src/tools/drawTools/vtoolheight.h index 936f46476..e65a0b311 100644 --- a/src/tools/drawTools/vtoolheight.h +++ b/src/tools/drawTools/vtoolheight.h @@ -44,7 +44,7 @@ public: * @param doc dom document container * @param data container with variables * @param id object id in container - * @param typeLine + * @param typeLine line type. * @param basePointId * @param p1LineId * @param p2LineId @@ -59,7 +59,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -68,19 +68,19 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param pointName - * @param typeLine + * @param typeLine line type. * @param basePointId * @param p1LineId * @param p2LineId - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &pointName, const QString &typeLine, diff --git a/src/tools/drawTools/vtoolline.h b/src/tools/drawTools/vtoolline.h index ce4836bca..d26a51acd 100644 --- a/src/tools/drawTools/vtoolline.h +++ b/src/tools/drawTools/vtoolline.h @@ -57,7 +57,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -66,14 +66,14 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param firstPoint * @param secondPoint * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 &_id, const qint64 &firstPoint, const qint64 &secondPoint, @@ -107,7 +107,7 @@ public slots: virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); protected: diff --git a/src/tools/drawTools/vtoollineintersect.h b/src/tools/drawTools/vtoollineintersect.h index 303618045..cf6113da7 100644 --- a/src/tools/drawTools/vtoollineintersect.h +++ b/src/tools/drawTools/vtoollineintersect.h @@ -59,7 +59,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -68,19 +68,19 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param p1Line1Id * @param p2Line1Id * @param p1Line2Id * @param p2Line2Id * @param pointName - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const qint64 &p1Line1Id, const qint64 &p2Line1Id, const qint64 &p1Line2Id, @@ -103,7 +103,7 @@ public slots: virtual void FullUpdateFromGui(int result); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); diff --git a/src/tools/drawTools/vtoollinepoint.h b/src/tools/drawTools/vtoollinepoint.h index f10d86852..a6430de81 100644 --- a/src/tools/drawTools/vtoollinepoint.h +++ b/src/tools/drawTools/vtoollinepoint.h @@ -43,7 +43,7 @@ public: * @param doc dom document container * @param data container with variables * @param id object id in container - * @param typeLine + * @param typeLine line type. * @param formula * @param basePointId * @param angle @@ -60,7 +60,7 @@ public slots: virtual void ChangedActivDraw(const QString &newName); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); protected: diff --git a/src/tools/drawTools/vtoolnormal.h b/src/tools/drawTools/vtoolnormal.h index f9b56d7b1..d61b9f6e1 100644 --- a/src/tools/drawTools/vtoolnormal.h +++ b/src/tools/drawTools/vtoolnormal.h @@ -44,7 +44,7 @@ public: * @param doc dom document container * @param data container with variables * @param id object id in container - * @param typeLine + * @param typeLine line type. * @param formula * @param angle * @param firstPointId @@ -61,7 +61,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -70,20 +70,20 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param formula * @param firstPointId * @param secondPointId - * @param typeLine + * @param typeLine line type. * @param pointName * @param angle - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &formula, const qint64 &firstPointId, @@ -117,7 +117,7 @@ public slots: virtual void FullUpdateFromGui(int result); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); diff --git a/src/tools/drawTools/vtoolpoint.h b/src/tools/drawTools/vtoolpoint.h index a77a0446e..b4842bd94 100644 --- a/src/tools/drawTools/vtoolpoint.h +++ b/src/tools/drawTools/vtoolpoint.h @@ -77,7 +77,7 @@ public slots: virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); @@ -96,8 +96,8 @@ protected: QGraphicsLineItem *lineName; /** * @brief UpdateNamePosition - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. */ virtual void UpdateNamePosition(qreal mx, qreal my); /** diff --git a/src/tools/drawTools/vtoolpointofcontact.h b/src/tools/drawTools/vtoolpointofcontact.h index 56765e28c..c07d24ed3 100644 --- a/src/tools/drawTools/vtoolpointofcontact.h +++ b/src/tools/drawTools/vtoolpointofcontact.h @@ -69,7 +69,7 @@ public: static QPointF FindPoint(const qreal &radius, const QPointF ¢er, const QPointF &firstPoint, const QPointF &secondPoint); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -78,19 +78,19 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param radius * @param center * @param firstPointId * @param secondPointId * @param pointName - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &radius, const qint64 ¢er, @@ -113,7 +113,7 @@ public slots: virtual void FullUpdateFromGui(int result); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); diff --git a/src/tools/drawTools/vtoolpointofintersection.h b/src/tools/drawTools/vtoolpointofintersection.h index e2db04c5f..da9a78e16 100644 --- a/src/tools/drawTools/vtoolpointofintersection.h +++ b/src/tools/drawTools/vtoolpointofintersection.h @@ -57,7 +57,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -66,17 +66,17 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param pointName * @param firstPointId * @param secondPointId - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &pointName, const qint64 &firstPointId, diff --git a/src/tools/drawTools/vtoolshoulderpoint.h b/src/tools/drawTools/vtoolshoulderpoint.h index 64ba9e53c..da1505dac 100644 --- a/src/tools/drawTools/vtoolshoulderpoint.h +++ b/src/tools/drawTools/vtoolshoulderpoint.h @@ -43,7 +43,7 @@ public: * @param doc dom document container * @param data container with variables * @param id object id in container - * @param typeLine + * @param typeLine line type. * @param formula * @param p1Line * @param p2Line @@ -70,7 +70,7 @@ public: static QPointF FindPoint(const QPointF &p1Line, const QPointF &p2Line, const QPointF &pShoulder, const qreal &length); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -79,20 +79,20 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param formula * @param p1Line * @param p2Line * @param pShoulder - * @param typeLine + * @param typeLine line type. * @param pointName - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &formula, const qint64 &p1Line, const qint64 &p2Line, @@ -115,7 +115,7 @@ public slots: virtual void FullUpdateFromGui(int result); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); diff --git a/src/tools/drawTools/vtoolsinglepoint.h b/src/tools/drawTools/vtoolsinglepoint.h index 938efc94f..9763772b8 100644 --- a/src/tools/drawTools/vtoolsinglepoint.h +++ b/src/tools/drawTools/vtoolsinglepoint.h @@ -74,7 +74,7 @@ public slots: virtual void ChangedActivDraw(const QString &newName); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); diff --git a/src/tools/drawTools/vtoolspline.h b/src/tools/drawTools/vtoolspline.h index 43f0627ef..79e5d929b 100644 --- a/src/tools/drawTools/vtoolspline.h +++ b/src/tools/drawTools/vtoolspline.h @@ -57,7 +57,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -66,7 +66,7 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param p1 * @param p4 @@ -78,7 +78,7 @@ public: * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const qint64 &p1, const qint64 &p4, const qreal &kAsm1, @@ -140,7 +140,7 @@ public slots: virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); protected: diff --git a/src/tools/drawTools/vtoolsplinepath.h b/src/tools/drawTools/vtoolsplinepath.h index d360555ea..58d93558a 100644 --- a/src/tools/drawTools/vtoolsplinepath.h +++ b/src/tools/drawTools/vtoolsplinepath.h @@ -56,7 +56,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -65,13 +65,13 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param path * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, VSplinePath *path, VMainGraphicsScene *scene, @@ -132,7 +132,7 @@ public slots: virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** * @brief SetFactor set current scale factor of scene. - * @param factor + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); protected: diff --git a/src/tools/drawTools/vtooltriangle.h b/src/tools/drawTools/vtooltriangle.h index ba447bb77..5ccba2ea4 100644 --- a/src/tools/drawTools/vtooltriangle.h +++ b/src/tools/drawTools/vtooltriangle.h @@ -59,7 +59,7 @@ public: */ virtual void setDialog(); /** - * @brief Create + * @brief Create help create tool * @param dialog * @param scene pointer to scene. * @param doc dom document container @@ -68,19 +68,19 @@ public: static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); /** - * @brief Create + * @brief Create help create tool * @param _id tool id, 0 if tool doesn't exist yet. * @param pointName * @param axisP1Id * @param axisP2Id * @param firstPointId * @param secondPointId - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. * @param scene pointer to scene. * @param doc dom document container * @param data container with variables - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(const qint64 _id, const QString &pointName, const qint64 &axisP1Id, const qint64 &axisP2Id, diff --git a/src/tools/nodeDetails/vnodearc.h b/src/tools/nodeDetails/vnodearc.h index 2a9202d17..cc3cbd00a 100644 --- a/src/tools/nodeDetails/vnodearc.h +++ b/src/tools/nodeDetails/vnodearc.h @@ -52,12 +52,12 @@ public: const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0, QGraphicsItem * parent = 0); /** - * @brief Create + * @brief Create help create tool * @param doc dom document container * @param data container with variables * @param id object id in container * @param id object id in containerArc - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idArc, const Document::Documents &parse, diff --git a/src/tools/nodeDetails/vnodepoint.h b/src/tools/nodeDetails/vnodepoint.h index 6dc725a86..c5b73c23f 100644 --- a/src/tools/nodeDetails/vnodepoint.h +++ b/src/tools/nodeDetails/vnodepoint.h @@ -52,12 +52,12 @@ public: const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0, QGraphicsItem * parent = 0 ); /** - * @brief Create + * @brief Create help create tool * @param doc dom document container * @param data container with variables * @param id object id in container * @param id object id in containerPoint - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idPoint, @@ -120,8 +120,8 @@ protected: virtual void hoverLeaveEvent ( QGraphicsSceneHoverEvent * event ); /** * @brief UpdateNamePosition - * @param mx - * @param my + * @param mx label bias x axis. + * @param my label bias y axis. */ virtual void UpdateNamePosition(qreal mx, qreal my); /** diff --git a/src/tools/nodeDetails/vnodespline.h b/src/tools/nodeDetails/vnodespline.h index 234fe3fe1..4bc729e3e 100644 --- a/src/tools/nodeDetails/vnodespline.h +++ b/src/tools/nodeDetails/vnodespline.h @@ -52,12 +52,12 @@ public: const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0, QGraphicsItem * parent = 0); /** - * @brief Create + * @brief Create help create tool * @param doc dom document container * @param data container with variables * @param id object id in container * @param id object id in containerSpline - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. * @return */ diff --git a/src/tools/nodeDetails/vnodesplinepath.h b/src/tools/nodeDetails/vnodesplinepath.h index 89e131cf4..866a7f3ed 100644 --- a/src/tools/nodeDetails/vnodesplinepath.h +++ b/src/tools/nodeDetails/vnodesplinepath.h @@ -52,12 +52,12 @@ public: const Tool::Sources &typeCreation, const qint64 &idTool = 0, QObject *qoParent = 0, QGraphicsItem * parent = 0); /** - * @brief Create + * @brief Create help create tool * @param doc dom document container * @param data container with variables * @param id object id in container * @param id object id in containerSpline - * @param parse + * @param parse parser file mode. * @param typeCreation way we create this tool. */ static void Create(VDomDocument *doc, VContainer *data, qint64 id, qint64 idSpline, diff --git a/src/tools/vtooluniondetails.h b/src/tools/vtooluniondetails.h index 1c5e06d49..d7c9bbabf 100644 --- a/src/tools/vtooluniondetails.h +++ b/src/tools/vtooluniondetails.h @@ -66,16 +66,6 @@ public: */ static void Create(QSharedPointer &dialog, VMainGraphicsScene *scene, VDomDocument *doc, VContainer *data); - /** - * @brief Create help create tool. - * @param _id tool id, 0 if tool doesn't exist yet. - * @param newDetail - * @param scene pointer to scene. - * @param doc dom document container - * @param data container with variables - * @param parse parser file mode. - * @param typeCreation way we create this tool. - */ /** * @brief Create help create tool. * @param _id tool id, 0 if tool doesn't exist yet. diff --git a/src/widgets/vmaingraphicsscene.h b/src/widgets/vmaingraphicsscene.h index ea51d2725..27a4b2e54 100644 --- a/src/widgets/vmaingraphicsscene.h +++ b/src/widgets/vmaingraphicsscene.h @@ -80,7 +80,7 @@ public slots: void ChoosedItem(qint64 id, const Scene::Scenes &type); /** * @brief SetFactor set current scale factor of scene. - * @param factor scene scale factor. + * @param factor scene scale factor. scene scale factor. */ void SetFactor(qreal factor); protected: @@ -113,7 +113,7 @@ signals: void ChoosedObject(qint64 id, Scene::Scenes type); /** * @brief NewFactor - * @param factor + * @param factor scene scale factor. */ void NewFactor(qreal factor); private: diff --git a/src/widgets/vmaingraphicsview.h b/src/widgets/vmaingraphicsview.h index 63cc710cf..af8d75710 100644 --- a/src/widgets/vmaingraphicsview.h +++ b/src/widgets/vmaingraphicsview.h @@ -46,7 +46,7 @@ public: signals: /** * @brief NewFactor - * @param factor + * @param factor scene scale factor. */ void NewFactor(qreal factor); public slots: diff --git a/src/widgets/vsimplespline.h b/src/widgets/vsimplespline.h index e202bf83a..51c065e68 100644 --- a/src/widgets/vsimplespline.h +++ b/src/widgets/vsimplespline.h @@ -51,7 +51,7 @@ public: /** * @brief VSimpleSpline * @param id - * @param factor + * @param factor scene scale factor. * @param currentColor * @param parent */ diff --git a/src/xml/vdomdocument.h b/src/xml/vdomdocument.h index 4ea252544..c6624a085 100644 --- a/src/xml/vdomdocument.h +++ b/src/xml/vdomdocument.h @@ -100,7 +100,7 @@ public: /** * @brief ChangeActivDraw * @param name - * @param parse + * @param parse parser file mode. */ void ChangeActivDraw(const QString& name, const Document::Documents &parse = Document::FullParse); /** @@ -146,7 +146,7 @@ public: bool SetNameDraw(const QString& name); /** * @brief Parse - * @param parse + * @param parse parser file mode. * @param sceneDraw * @param sceneDetail */ @@ -338,7 +338,7 @@ private: * @param sceneDraw * @param sceneDetail * @param node - * @param parse + * @param parse parser file mode. */ void ParseDrawElement(VMainGraphicsScene *sceneDraw, VMainGraphicsScene *sceneDetail, const QDomNode& node, const Document::Documents &parse); @@ -347,7 +347,7 @@ private: * @param sceneDraw * @param sceneDetail * @param node - * @param parse + * @param parse parser file mode. * @param mode */ void ParseDrawMode(VMainGraphicsScene *sceneDraw, VMainGraphicsScene *sceneDetail, @@ -356,7 +356,7 @@ private: * @brief ParseDetailElement * @param sceneDetail * @param domElement - * @param parse + * @param parse parser file mode. */ void ParseDetailElement(VMainGraphicsScene *sceneDetail, const QDomElement &domElement, const Document::Documents &parse); @@ -364,7 +364,7 @@ private: * @brief ParseDetails * @param sceneDetail * @param domElement - * @param parse + * @param parse parser file mode. */ void ParseDetails(VMainGraphicsScene *sceneDetail, const QDomElement &domElement, const Document::Documents &parse); @@ -372,7 +372,7 @@ private: * @brief ParsePointElement * @param scene * @param domElement - * @param parse + * @param parse parser file mode. * @param type * @param mode */ @@ -382,7 +382,7 @@ private: * @brief ParseLineElement * @param scene * @param domElement - * @param parse + * @param parse parser file mode. * @param mode */ void ParseLineElement(VMainGraphicsScene *scene, const QDomElement& domElement, @@ -391,7 +391,7 @@ private: * @brief ParseSplineElement * @param scene * @param domElement - * @param parse + * @param parse parser file mode. * @param type * @param mode */ @@ -401,7 +401,7 @@ private: * @brief ParseArcElement * @param scene * @param domElement - * @param parse + * @param parse parser file mode. * @param type * @param mode */