Форматирование под doxygen

Canvas.cpp

@@ -8,13 +8,30 @@ std::set<Point*> groups;
 // Вспомогательные функции
 // ===================================================================
 
-/// Вычислить расстояние между двумя точками
+/**
+ * @brief Вычислить расстояние между двумя точками
+ * @param p1 Первая точка
+ * @param p2 Вторая точка
+ * @return Расстояние между точками
+ */
 static double dist_P2P(QPointF p1, QPointF p2)
 {
     return sqrt(pow(p2.x() - p1.x(), 2) + pow(p2.y() - p1.y(), 2));
 }
 
-/// Создать упорядоченную пару (чтобы pair(obj1, obj2) и pair(obj2, obj1) считались одинаковыми)
+/**
+ * @brief Создать упорядоченную пару
+ *
+ * Создает пару, в которой элементы упорядочены по указателям,
+ * чтобы pair(obj1, obj2) и pair(obj2, obj1) считались одинаковыми
+ *
+ * @tparam T Тип возвращаемой пары
+ * @tparam A Тип первого элемента
+ * @tparam B Тип второго элемента
+ * @param obj1 Первый объект
+ * @param obj2 Второй объект
+ * @return Упорядоченная пара
+ */
 template <typename T, typename A, typename B>
 T makeOrderedPair(A* obj1, B* obj2)
 {
@@ -41,7 +58,7 @@ Canvas::~Canvas()
 }
 
 // ===================================================================
-// Методы изменения режима
+// Методы изменения режима и масштаба
 // ===================================================================
 
 void Canvas::changeMode(Mode _mode)
@@ -141,7 +158,6 @@ bool Canvas::areAlreadyPerpendicular(Line* line1, Line* line2)
 // Методы работы с ограничениями
 // ===================================================================
 
-// TODO - переделать в bool для отображения статуса выполнения
 void Canvas::remove_constraint(int tag)
 {
     auto it = C_Info.find(tag);
@@ -380,9 +396,9 @@ void Canvas::mousePressEvent(QMouseEvent* event)
         }
         else {
             // Линии уже параллельны - сообщаем об ошибке
-    #ifdef _DEBUG
+#ifdef _DEBUG
             qDebug() << "Line" << current_line << "and" << found << "are parallel. Abort!";
-    #endif
+#endif
 
             QMessageBox::warning(this,
                 QString("Wrong"),
@@ -553,10 +569,10 @@ void Canvas::mouseMoveEvent(QMouseEvent* event)
         }
         solve_for_canvas();
     }
-    #ifdef _DEBUG
+#ifdef _DEBUG
     else
         showObjectTag(WIDGET_POSITION);
-    #endif
+#endif
 }
 
 void Canvas::mouseReleaseEvent(QMouseEvent* event)
@@ -637,6 +653,10 @@ void Canvas::paintEvent(QPaintEvent* event)
     }
 }
 
+// ===================================================================
+// Обработчики событий клавиатуры и колесика мыши
+// ===================================================================
+
 void Canvas::keyPressEvent(QKeyEvent* event)
 {
     switch (event->key()) {
@@ -734,11 +754,15 @@ void Canvas::showObjectTag(QPointF pos)
             .arg(info_line.length());
         QToolTip::showText(mapToGlobal(pos.toPoint()), Text, this);
     }
-    else 
+    else
         QToolTip::hideText();
 }
 #endif
 
+// ===================================================================
+// Вспомогательные методы
+// ===================================================================
+
 QPointF Canvas::screenToLogical(const QPointF& screenPos) const
 {
     QPointF logical = screenPos;
@@ -787,13 +811,13 @@ void Canvas::solve_for_canvas()
             }
         }
     }
-    
+
     if (flag) {
         QMessageBox::warning(this, QString("Error!"), QString("Last constraint is unavailable!"));
-            remove_constraint(constraints_count - 1);
-            C_Info.erase(constraints_count - 1);
-            constraints_count--;
-        }
+        remove_constraint(constraints_count - 1);
+        C_Info.erase(constraints_count - 1);
+        constraints_count--;
+    }
     after_constraint = false;
     update();
 }