diff --git a/src/tools/drawTools/vtoolnormal.h b/src/tools/drawTools/vtoolnormal.h index e92dd0684..8e9947e14 100644 --- a/src/tools/drawTools/vtoolnormal.h +++ b/src/tools/drawTools/vtoolnormal.h @@ -33,24 +33,24 @@ #include "../../dialogs/dialognormal.h" /** - * @brief The VToolNormal class + * @brief The VToolNormal class tool for creation point on normal. Normal begin from first point of line. */ class VToolNormal : public VToolLinePoint { Q_OBJECT public: /** - * @brief VToolNormal - * @param doc dom document container - * @param data container with variables - * @param id object id in container + * @brief VToolNormal constructor. + * @param doc dom document container. + * @param data container with variables. + * @param id object id in container. * @param typeLine line type. - * @param formula - * @param angle - * @param firstPointId - * @param secondPointId + * @param formula string with formula normal length. + * @param angle additional angle. + * @param firstPointId id first line point. + * @param secondPointId id second line point. * @param typeCreation way we create this tool. - * @param parent parent object + * @param parent parent object. */ VToolNormal(VDomDocument *doc, VContainer *data, const qint64 &id, const QString &typeLine, const QString &formula, const qreal &angle, const qint64 &firstPointId, @@ -61,28 +61,28 @@ public: */ virtual void setDialog(); /** - * @brief Create help create tool - * @param dialog + * @brief Create help create tool from GUI. + * @param dialog dialog. * @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 help create tool + * @brief Create help create tool. * @param _id tool id, 0 if tool doesn't exist yet. - * @param formula - * @param firstPointId - * @param secondPointId + * @param formula string with formula normal length. + * @param firstPointId id first line point. + * @param secondPointId id second line point. * @param typeLine line type. * @param pointName point name. - * @param angle + * @param angle additional angle. * @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 doc dom document container. + * @param data container with variables. * @param parse parser file mode. * @param typeCreation way we create this tool. */ @@ -92,18 +92,15 @@ public: VDomDocument *doc, VContainer *data, const Document::Documents &parse, const Tool::Sources &typeCreation); /** - * @brief FindPoint - * @param firstPoint - * @param secondPoint - * @param length - * @param angle - * @return + * @brief FindPoint return normal point. + * @param firstPoint first line point. + * @param secondPoint second line point. + * @param length normal length. + * @param angle additional angle. + * @return normal point. */ static QPointF FindPoint(const QPointF &firstPoint, const QPointF &secondPoint, const qreal &length, const qreal &angle = 0); - /** - * @brief ToolType - */ static const QString ToolType; public slots: /** @@ -112,7 +109,7 @@ 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); /** @@ -120,11 +117,15 @@ public slots: * @param factor scene scale factor. */ virtual void SetFactor(qreal factor); + /** + * @brief ShowContextMenu show context menu. + * @param event context menu event. + */ virtual void ShowContextMenu(QGraphicsSceneContextMenuEvent *event); protected: /** * @brief contextMenuEvent handle context menu events. - * @param event + * @param event context menu event. */ virtual void contextMenuEvent ( QGraphicsSceneContextMenuEvent * event ); /** @@ -141,11 +142,11 @@ protected: virtual void RemoveReferens(); private: /** - * @brief secondPointId + * @brief secondPointId id second line point. */ qint64 secondPointId; /** - * @brief dialogNormal + * @brief dialogNormal dialog. */ QSharedPointer dialogNormal; };