From 1b877ca978a76de34500da97feefed61189f9665 Mon Sep 17 00:00:00 2001 From: dismine Date: Fri, 30 May 2014 12:12:20 +0300 Subject: [PATCH] Move documentation to cpp file. --HG-- branch : feature --- src/app/tools/drawTools/vdrawtool.cpp | 36 +++++++++++ src/app/tools/drawTools/vdrawtool.h | 90 +++++++++------------------ 2 files changed, 65 insertions(+), 61 deletions(-) diff --git a/src/app/tools/drawTools/vdrawtool.cpp b/src/app/tools/drawTools/vdrawtool.cpp index 25f329719..3626c5982 100644 --- a/src/app/tools/drawTools/vdrawtool.cpp +++ b/src/app/tools/drawTools/vdrawtool.cpp @@ -31,6 +31,13 @@ qreal VDrawTool::factor = 1; //--------------------------------------------------------------------------------------------------------------------- +/** + * @brief VDrawTool constructor. + * @param doc dom document container. + * @param data container with variables. + * @param id object id in container. + * @param parent parent object. + */ VDrawTool::VDrawTool(VPattern *doc, VContainer *data, quint32 id) :VAbstractTool(doc, data, id), ignoreContextMenuEvent(false), ignoreFullUpdate(false), nameActivDraw(doc->GetNameActivDraw()), dialog(nullptr) @@ -46,7 +53,15 @@ VDrawTool::~VDrawTool() delete dialog; } + + //--------------------------------------------------------------------------------------------------------------------- +/** + * @brief ShowTool highlight tool. + * @param id object id in container. + * @param color highlight color. + * @param enable enable or disable highlight. + */ void VDrawTool::ShowTool(quint32 id, Qt::GlobalColor color, bool enable) { Q_UNUSED(id); @@ -55,6 +70,10 @@ void VDrawTool::ShowTool(quint32 id, Qt::GlobalColor color, bool enable) } //--------------------------------------------------------------------------------------------------------------------- +/** + * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. + * @param newName new name active pattern peace. name new active pattern peace. + */ void VDrawTool::ChangedActivDraw(const QString &newName) { if (nameActivDraw == newName) @@ -68,6 +87,11 @@ void VDrawTool::ChangedActivDraw(const QString &newName) } //--------------------------------------------------------------------------------------------------------------------- +/** + * @brief ChangedNameDraw save new name active pattern peace. + * @param oldName old name. + * @param newName new name active pattern peace. new name. + */ void VDrawTool::ChangedNameDraw(const QString &oldName, const QString &newName) { if (nameActivDraw == oldName) @@ -77,6 +101,10 @@ void VDrawTool::ChangedNameDraw(const QString &oldName, const QString &newName) } //--------------------------------------------------------------------------------------------------------------------- +/** + * @brief FullUpdateFromGui refresh tool data after change in options. + * @param result keep result working dialog. + */ void VDrawTool::FullUpdateFromGui(int result) { if (result == QDialog::Accepted) @@ -95,6 +123,10 @@ void VDrawTool::FullUpdateFromGui(int result) } //--------------------------------------------------------------------------------------------------------------------- +/** + * @brief SetFactor set current scale factor of scene. + * @param factor scene scale factor. + */ void VDrawTool::SetFactor(qreal factor) { if (factor <= 2 && factor >= 0.5) @@ -104,6 +136,10 @@ void VDrawTool::SetFactor(qreal factor) } //--------------------------------------------------------------------------------------------------------------------- +/** + * @brief AddToCalculation add tool to calculation tag in pattern file. + * @param domElement tag in xml tree. + */ void VDrawTool::AddToCalculation(const QDomElement &domElement) { QDomElement calcElement; diff --git a/src/app/tools/drawTools/vdrawtool.h b/src/app/tools/drawTools/vdrawtool.h index af389a880..437798af4 100644 --- a/src/app/tools/drawTools/vdrawtool.h +++ b/src/app/tools/drawTools/vdrawtool.h @@ -42,83 +42,41 @@ class VDrawTool : public VAbstractTool { Q_OBJECT public: - /** - * @brief VDrawTool constructor. - * @param doc dom document container. - * @param data container with variables. - * @param id object id in container. - * @param parent parent object. - */ - VDrawTool(VPattern *doc, VContainer *data, quint32 id); + + VDrawTool(VPattern *doc, VContainer *data, quint32 id); virtual ~VDrawTool(); - /** - * @brief setDialog set dialog when user want change tool option. - */ + + /** @brief setDialog set dialog when user want change tool option. */ virtual void setDialog() {} - /** - * @brief ignoreContextMenu set ignore contect menu tool. - * @param enable true - ignore. - */ - void ignoreContextMenu(bool enable) {ignoreContextMenuEvent = enable;} + + void ignoreContextMenu(bool enable); public slots: - /** - * @brief ShowTool highlight tool. - * @param id object id in container. - * @param color highlight color. - * @param enable enable or disable highlight. - */ virtual void ShowTool(quint32 id, Qt::GlobalColor color, bool enable); - /** - * @brief ChangedActivDraw disable or enable context menu after change active pattern peace. - * @param newName new name active pattern peace. name new active pattern peace. - */ virtual void ChangedActivDraw(const QString &newName); - /** - * @brief ChangedNameDraw save new name active pattern peace. - * @param oldName old name. - * @param newName new name active pattern peace. new name. - */ void ChangedNameDraw(const QString &oldName, const QString &newName); - /** - * @brief FullUpdateFromGui refresh tool data after change in options. - * @param result keep result working dialog. - */ virtual void FullUpdateFromGui(int result); - /** - * @brief SetFactor set current scale factor of scene. - * @param factor scene scale factor. - */ virtual void SetFactor(qreal factor); protected: - /** - * @brief ignoreContextMenuEvent ignore or not context menu events. - */ + /** @brief ignoreContextMenuEvent ignore or not context menu events. */ bool ignoreContextMenuEvent; - /** - * @brief ignoreFullUpdate ignore or not full updates. - */ + + /** @brief ignoreFullUpdate ignore or not full updates. */ bool ignoreFullUpdate; - /** - * @brief nameActivDraw name of tool's pattern peace. - */ + + /** @brief nameActivDraw name of tool's pattern peace. */ QString nameActivDraw; - /** - * @brief factor scene scale factor. - */ + + /** @brief factor scene scale factor. */ static qreal factor; - /** - * @brief dialog dialog options. - */ + + /** @brief dialog dialog options.*/ DialogTool *dialog; - /** - * @brief AddToCalculation add tool to calculation tag in pattern file. - * @param domElement tag in xml tree. - */ + void AddToCalculation(const QDomElement &domElement); - /** - * @brief SaveDialog save options into file after change in dialog. - */ + + /** @brief SaveDialog save options into file after change in dialog. */ virtual void SaveDialog(QDomElement &domElement)=0; + template /** * @brief ContextMenu show context menu for tool. @@ -203,4 +161,14 @@ private: Q_DISABLE_COPY(VDrawTool) }; +//--------------------------------------------------------------------------------------------------------------------- +/** + * @brief ignoreContextMenu set ignore contect menu tool. + * @param enable true - ignore. + */ +inline void VDrawTool::ignoreContextMenu(bool enable) +{ + ignoreContextMenuEvent = enable; +} + #endif // VDRAWTOOL_H