From e5f58b7a1074175db0a4b7ffb8ed8c48fae2f725 Mon Sep 17 00:00:00 2001 From: dismine Date: Fri, 24 Jan 2014 17:56:41 +0200 Subject: [PATCH] Documentation for VDrawTool class. --HG-- branch : develop --- src/mainwindow.h | 2 +- src/tools/drawTools/vdrawtool.h | 74 +++++++++---------- src/tools/drawTools/vtoolalongline.h | 4 +- src/tools/drawTools/vtoolarc.h | 8 +- src/tools/drawTools/vtoolbisector.h | 4 +- src/tools/drawTools/vtoolcutarc.h | 4 +- src/tools/drawTools/vtoolcutspline.h | 4 +- src/tools/drawTools/vtoolcutsplinepath.h | 4 +- src/tools/drawTools/vtoolendline.h | 2 +- src/tools/drawTools/vtoolheight.h | 2 +- src/tools/drawTools/vtoolline.h | 8 +- src/tools/drawTools/vtoollineintersect.h | 4 +- src/tools/drawTools/vtoollinepoint.h | 4 +- src/tools/drawTools/vtoolnormal.h | 4 +- src/tools/drawTools/vtoolpoint.h | 8 +- src/tools/drawTools/vtoolpointofcontact.h | 4 +- .../drawTools/vtoolpointofintersection.h | 2 +- src/tools/drawTools/vtoolshoulderpoint.h | 4 +- src/tools/drawTools/vtoolsinglepoint.h | 6 +- src/tools/drawTools/vtoolspline.h | 8 +- src/tools/drawTools/vtoolsplinepath.h | 8 +- src/tools/drawTools/vtooltriangle.h | 2 +- src/widgets/vmaingraphicsscene.h | 4 +- src/xml/vdomdocument.h | 10 +-- 24 files changed, 92 insertions(+), 92 deletions(-) diff --git a/src/mainwindow.h b/src/mainwindow.h index fe907af36..d578dacf2 100644 --- a/src/mainwindow.h +++ b/src/mainwindow.h @@ -347,7 +347,7 @@ public slots: */ void AboutQt(); /** - * @brief ShowToolTip show tools tooltip. + * @brief ShowTool highlight tool.Tip show tools tooltip. * @param toolTip tooltip text. */ void ShowToolTip(const QString &toolTip); diff --git a/src/tools/drawTools/vdrawtool.h b/src/tools/drawTools/vdrawtool.h index 94e3044be..6f7ec80d1 100644 --- a/src/tools/drawTools/vdrawtool.h +++ b/src/tools/drawTools/vdrawtool.h @@ -35,18 +35,18 @@ #include /** - * @brief The VDrawTool class + * @brief The VDrawTool abstract class for all draw tool. */ class VDrawTool : public VAbstractTool { Q_OBJECT public: /** - * @brief VDrawTool - * @param doc dom document container - * @param data container with variables - * @param id object id in container - * @param parent parent object + * @brief VDrawTool constructor. + * @param doc dom document container. + * @param data container with variables. + * @param id object id in container. + * @param parent parent object. */ VDrawTool(VDomDocument *doc, VContainer *data, qint64 id); virtual ~VDrawTool() {} @@ -55,68 +55,68 @@ public: */ virtual void setDialog() {} /** - * @brief ignoreContextMenu - * @param enable + * @brief ignoreContextMenu set ignore contect menu tool. + * @param enable true - ignore. */ void ignoreContextMenu(bool enable) {ignoreContextMenuEvent = enable;} public slots: /** - * @brief ShowTool - * @param id object id in container - * @param color - * @param enable + * @brief ShowTool highlight tool. + * @param id object id in container. + * @param color highlight color. + * @param enable enable or disable highlight. */ virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** - * @brief ChangedActivDraw - * @param newName + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. + * @param newName name new active pattern peace. */ virtual void ChangedActivDraw(const QString &newName); /** - * @brief ChangedNameDraw - * @param oldName - * @param newName + * @brief ChangedNameDraw save new name active pattern peace. + * @param oldName old name. + * @param newName new name. */ void ChangedNameDraw(const QString &oldName, const QString &newName); /** - * @brief FullUpdateFromGui - * @param result + * @brief FullUpdateFromGui refresh tool data from change options. + * @param result keep result working dialog. */ virtual void FullUpdateFromGui(int result)=0; /** - * @brief SetFactor - * @param factor + * @brief SetFactor set current scale factor of scene. + * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); protected: /** - * @brief ignoreContextMenuEvent + * @brief ignoreContextMenuEvent ignore or not context menu events. */ bool ignoreContextMenuEvent; /** - * @brief ignoreFullUpdate + * @brief ignoreFullUpdate ignore or not full updates. */ bool ignoreFullUpdate; /** - * @brief nameActivDraw + * @brief nameActivDraw name of tool's pattern peace. */ QString nameActivDraw; /** - * @brief factor + * @brief factor scene scale factor. */ static qreal factor; /** - * @brief AddToCalculation - * @param domElement + * @brief AddToCalculation add tool to calculation tag in pattern file. + * @param domElement tag in xml tree. */ void AddToCalculation(const QDomElement &domElement); template /** - * @brief ContextMenu - * @param dialog - * @param tool - * @param event - * @param showRemove + * @brief ContextMenu show context menu for tool. + * @param dialog dialog option. + * @param tool tool. + * @param event context menu event. + * @param showRemove true - tool have option delete. */ void ContextMenu(QSharedPointer &dialog, Tool *tool, QGraphicsSceneContextMenuEvent *event, bool showRemove = true) @@ -168,11 +168,11 @@ protected: } template /** - * @brief ShowItem - * @param item - * @param id object id in container - * @param color - * @param enable + * @brief ShowItem highlight tool. + * @param item tool. + * @param id object id in container. + * @param color highlight color. + * @param enable enable or disable highlight. */ void ShowItem(Item *item, qint64 id, Qt::GlobalColor color, bool enable) { diff --git a/src/tools/drawTools/vtoolalongline.h b/src/tools/drawTools/vtoolalongline.h index 35756f9bd..44f9fc9a4 100644 --- a/src/tools/drawTools/vtoolalongline.h +++ b/src/tools/drawTools/vtoolalongline.h @@ -97,12 +97,12 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolarc.h b/src/tools/drawTools/vtoolarc.h index 36043ea3d..8557388b0 100644 --- a/src/tools/drawTools/vtoolarc.h +++ b/src/tools/drawTools/vtoolarc.h @@ -94,24 +94,24 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); /** - * @brief ShowTool + * @brief ShowTool highlight tool. * @param id object id in container * @param color * @param enable */ virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolbisector.h b/src/tools/drawTools/vtoolbisector.h index d991b3d14..0822d03d9 100644 --- a/src/tools/drawTools/vtoolbisector.h +++ b/src/tools/drawTools/vtoolbisector.h @@ -110,12 +110,12 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolcutarc.h b/src/tools/drawTools/vtoolcutarc.h index ddc8eaf36..c05c9c2fe 100644 --- a/src/tools/drawTools/vtoolcutarc.h +++ b/src/tools/drawTools/vtoolcutarc.h @@ -60,7 +60,7 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); @@ -70,7 +70,7 @@ public slots: */ void ArcChoosed(qint64 id); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); diff --git a/src/tools/drawTools/vtoolcutspline.h b/src/tools/drawTools/vtoolcutspline.h index 5c89137eb..9a1185884 100644 --- a/src/tools/drawTools/vtoolcutspline.h +++ b/src/tools/drawTools/vtoolcutspline.h @@ -95,7 +95,7 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); @@ -105,7 +105,7 @@ public slots: */ void SplineChoosed(qint64 id); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); diff --git a/src/tools/drawTools/vtoolcutsplinepath.h b/src/tools/drawTools/vtoolcutsplinepath.h index 6422285a5..eb244b655 100644 --- a/src/tools/drawTools/vtoolcutsplinepath.h +++ b/src/tools/drawTools/vtoolcutsplinepath.h @@ -85,7 +85,7 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); @@ -95,7 +95,7 @@ public slots: */ void SplineChoosed(qint64 id); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); diff --git a/src/tools/drawTools/vtoolendline.h b/src/tools/drawTools/vtoolendline.h index c81aadfe4..c38144e3e 100644 --- a/src/tools/drawTools/vtoolendline.h +++ b/src/tools/drawTools/vtoolendline.h @@ -97,7 +97,7 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); diff --git a/src/tools/drawTools/vtoolheight.h b/src/tools/drawTools/vtoolheight.h index 518e1e7c6..936f46476 100644 --- a/src/tools/drawTools/vtoolheight.h +++ b/src/tools/drawTools/vtoolheight.h @@ -104,7 +104,7 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); diff --git a/src/tools/drawTools/vtoolline.h b/src/tools/drawTools/vtoolline.h index 0b2840500..ce4836bca 100644 --- a/src/tools/drawTools/vtoolline.h +++ b/src/tools/drawTools/vtoolline.h @@ -89,24 +89,24 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief ShowTool + * @brief ShowTool highlight tool. * @param id object id in container * @param color * @param enable */ virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoollineintersect.h b/src/tools/drawTools/vtoollineintersect.h index 0528c9cda..303618045 100644 --- a/src/tools/drawTools/vtoollineintersect.h +++ b/src/tools/drawTools/vtoollineintersect.h @@ -97,12 +97,12 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoollinepoint.h b/src/tools/drawTools/vtoollinepoint.h index 99bcf186d..f10d86852 100644 --- a/src/tools/drawTools/vtoollinepoint.h +++ b/src/tools/drawTools/vtoollinepoint.h @@ -54,12 +54,12 @@ public: QGraphicsItem * parent = 0); public slots: /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolnormal.h b/src/tools/drawTools/vtoolnormal.h index 6b8662b0a..f9b56d7b1 100644 --- a/src/tools/drawTools/vtoolnormal.h +++ b/src/tools/drawTools/vtoolnormal.h @@ -111,12 +111,12 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolpoint.h b/src/tools/drawTools/vtoolpoint.h index cfdda24fd..a77a0446e 100644 --- a/src/tools/drawTools/vtoolpoint.h +++ b/src/tools/drawTools/vtoolpoint.h @@ -59,24 +59,24 @@ public slots: */ void NameChangePosition(const QPointF &pos); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result) = 0; /** - * @brief ShowTool + * @brief ShowTool highlight tool. * @param id object id in container * @param color * @param enable */ virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolpointofcontact.h b/src/tools/drawTools/vtoolpointofcontact.h index ea7cf4447..56765e28c 100644 --- a/src/tools/drawTools/vtoolpointofcontact.h +++ b/src/tools/drawTools/vtoolpointofcontact.h @@ -107,12 +107,12 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolpointofintersection.h b/src/tools/drawTools/vtoolpointofintersection.h index 1c469cc40..e2db04c5f 100644 --- a/src/tools/drawTools/vtoolpointofintersection.h +++ b/src/tools/drawTools/vtoolpointofintersection.h @@ -93,7 +93,7 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); diff --git a/src/tools/drawTools/vtoolshoulderpoint.h b/src/tools/drawTools/vtoolshoulderpoint.h index 404e54a70..64ba9e53c 100644 --- a/src/tools/drawTools/vtoolshoulderpoint.h +++ b/src/tools/drawTools/vtoolshoulderpoint.h @@ -109,12 +109,12 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolsinglepoint.h b/src/tools/drawTools/vtoolsinglepoint.h index 722a1f594..938efc94f 100644 --- a/src/tools/drawTools/vtoolsinglepoint.h +++ b/src/tools/drawTools/vtoolsinglepoint.h @@ -63,17 +63,17 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolspline.h b/src/tools/drawTools/vtoolspline.h index ff77ab343..43f0627ef 100644 --- a/src/tools/drawTools/vtoolspline.h +++ b/src/tools/drawTools/vtoolspline.h @@ -114,7 +114,7 @@ public slots: */ virtual void FullUpdateFromFile (); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui ( int result ); @@ -127,19 +127,19 @@ public slots: void ControlPointChangePosition (const qint32 &indexSpline, const SplinePoint::Position &position, const QPointF &pos); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw ( const QString &newName ); /** - * @brief ShowTool + * @brief ShowTool highlight tool. * @param id object id in container * @param color * @param enable */ virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtoolsplinepath.h b/src/tools/drawTools/vtoolsplinepath.h index 849b90522..d360555ea 100644 --- a/src/tools/drawTools/vtoolsplinepath.h +++ b/src/tools/drawTools/vtoolsplinepath.h @@ -106,7 +106,7 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); @@ -119,19 +119,19 @@ public slots: void ControlPointChangePosition(const qint32 &indexSpline, const SplinePoint::Position &position, const QPointF &pos); /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ virtual void ChangedActivDraw(const QString &newName); /** - * @brief ShowTool + * @brief ShowTool highlight tool. * @param id object id in container * @param color * @param enable */ virtual void ShowTool(qint64 id, Qt::GlobalColor color, bool enable); /** - * @brief SetFactor + * @brief SetFactor set current scale factor of scene. * @param factor */ virtual void SetFactor(qreal factor); diff --git a/src/tools/drawTools/vtooltriangle.h b/src/tools/drawTools/vtooltriangle.h index a14ffb461..ba447bb77 100644 --- a/src/tools/drawTools/vtooltriangle.h +++ b/src/tools/drawTools/vtooltriangle.h @@ -107,7 +107,7 @@ public slots: */ virtual void FullUpdateFromFile(); /** - * @brief FullUpdateFromGui + * @brief FullUpdateFromGui refresh tool data from change options. * @param result */ virtual void FullUpdateFromGui(int result); diff --git a/src/widgets/vmaingraphicsscene.h b/src/widgets/vmaingraphicsscene.h index c0574caf9..ea51d2725 100644 --- a/src/widgets/vmaingraphicsscene.h +++ b/src/widgets/vmaingraphicsscene.h @@ -79,8 +79,8 @@ public slots: */ void ChoosedItem(qint64 id, const Scene::Scenes &type); /** - * @brief SetFactor - * @param factor + * @brief SetFactor set current scale factor of scene. + * @param factor scene scale factor. */ void SetFactor(qreal factor); protected: diff --git a/src/xml/vdomdocument.h b/src/xml/vdomdocument.h index c2ff3e1ad..4ea252544 100644 --- a/src/xml/vdomdocument.h +++ b/src/xml/vdomdocument.h @@ -228,14 +228,14 @@ public: qint64 SPointActiveDraw(); signals: /** - * @brief ChangedActivDraw + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. * @param newName */ void ChangedActivDraw(const QString &newName); /** - * @brief ChangedNameDraw - * @param oldName - * @param newName + * @brief ChangedNameDraw save new name active pattern peace. + * @param oldName old name. + * @param newName new name. */ void ChangedNameDraw(const QString &oldName, const QString &newName); /** @@ -247,7 +247,7 @@ signals: */ void haveChange(); /** - * @brief ShowTool + * @brief ShowTool highlight tool. * @param id * @param color * @param enable