Debug

.github/workflows/static.yml

@@ -0,0 +1,52 @@
+name: Deploy static content to Pages
+
+on:
+  push:
+    branches:
+      - "main"  # или ваша основная ветка, например, "main"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      # Устанавливаем Doxygen
+      - name: Install Doxygen
+        run: sudo apt install doxygen && doxygen --version
+
+      # Устанавливаем Graphviz (если нужно для генерации графиков в Doxygen)
+      - name: Install Graphviz
+        run: sudo apt install graphviz
+
+      # Создаем документацию
+      - name: Create documentation
+        run: doxygen
+
+      # Загрузка артефакта (с учетом структуры папок)
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/doxygen/html'  # Указываем правильный путь к сгенерированной документации
+
+      # Разворачиваем на GitHub Pages
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Doxyfile

@@ -0,0 +1,48 @@
+# Основные настройки
+PROJECT_NAME           = "My Project"         # Название проекта
+PROJECT_BRIEF          = "Project description"  # Краткое описание проекта
+OUTPUT_DIRECTORY       = docs/doxygen           # Папка для вывода документации
+CREATE_SUBDIRS         = NO                    # Не создавать подкаталоги для выходных файлов
+EXTRACT_ALL            = YES                   # Извлекать все комментарии (даже если нет тегов Doxygen)
+EXTRACT_PRIVATE        = YES                   # Включать приватные члены
+EXTRACT_STATIC         = YES                   # Включать статические функции и переменные
+INLINE_SOURCES         = YES                   # Включать исходный код в документацию
+FILE_PATTERNS          = *.h *.cpp             # Паттерны для поиска исходных файлов
+RECURSIVE              = YES                   # Рекурсивный поиск по каталогам
+ENABLE_PREPROCESSING   = YES                   # Разрешить обработку препроцессора
+MACRO_EXPANSION        = YES                   # Разрешить расширение макросов
+TCL_SUBST              = YES                   # Разрешить обработку команд TCL
+
+# Формат вывода документации
+GENERATE_HTML          = YES                   # Генерация HTML документации
+HTML_OUTPUT            = html                  # Папка для вывода HTML файлов
+HTML_EXTRA_STYLESHEET  = ""                    # Кастомный файл стилей (если есть)
+
+# Формат LaTeX (если нужен)
+GENERATE_LATEX         = YES                    # Отключить генерацию LaTeX документации
+
+
+# Использование Doxygen комментариев
+ALIASES                = "myalias=somealias"   # Можно настроить пользовательские алиасы (не обязательно)
+TEMPLATE_RELATIONS     = YES                   # Включить создание связей между файлами и классами
+HAVE_DOT               = YES                   # Использовать Graphviz для генерации графиков и диаграмм
+
+# Функции и классы
+EXTRACT_LOCAL_CLASSES  = YES                   # Включать локальные классы в документацию
+EXTRACT_LOCAL_METHODS  = YES                   # Включать локальные методы в документацию
+
+# Включение/выключение различных типов документации
+SHOW_FILES             = YES                   # Показать файлы в документации
+SHOW_NAMESPACES        = YES                   # Показать пространства имен
+SHOW_INCLUDE_FILES     = YES                   # Показать включаемые файлы
+
+# Визуальные параметры
+HTML_DYNAMIC_MENUS     = YES                   # Включить динамические меню в HTML документации
+HTML_COLORSTYLE        = "yes"                 # Включить стилизацию документации
+
+# Включение тэгов Doxygen в комментариях
+JAVADOC_AUTOBRIEF      = YES                   # Автоматически добавлять краткое описание в JavaDoc стиле
+DISTRIBUTE_GROUPS      = YES                   # Разрешить группировку документации
+
+# Путь к исходным файлам
+INPUT                  = ./server ./client  # Путь к вашим исходным файлам

client/Singleton.h

@@ -1,53 +1,86 @@
 #ifndef SINGLETON_H
 #define SINGLETON_H
+
 #include <QObject>
 #include <QTcpSocket>
 #include <QtNetwork>
 #include <QByteArray>
 #include <QDebug>
 #include <QStringList>
 
-
-class ClientSingleton;
-
-
+/**
+ * @brief Разрушитель Singleton для корректного удаления ClientSingleton.
+ */
 class ClientSingletonDestroyer {
-    private:
-        ClientSingleton * p_instance;
-    public:
-        ~ClientSingletonDestroyer();
-        void initialize(ClientSingleton * p);
+private:
+    ClientSingleton* p_instance;  /**< Указатель на экземпляр ClientSingleton */
+public:
+    /**
+     * @brief Деструктор. Удаляет экземпляр ClientSingleton.
+     */
+    ~ClientSingletonDestroyer();
+
+    /**
+     * @brief Инициализирует указатель на Singleton.
+     * @param p Указатель на экземпляр ClientSingleton.
+     */
+    void initialize(ClientSingleton* p);
 };
 
 
-
-class ClientSingleton : public QObject
-{
+/**
+ * @brief Сетевой клиент, реализующий паттерн Singleton.
+ *
+ * Используется для подключения к серверу, отправки и получения данных.
+ */
+class ClientSingleton : public QObject {
     Q_OBJECT
+
 private:
-    static ClientSingleton * p_instance;
-    static ClientSingletonDestroyer destroyer;
-    QTcpSocket* socket;
+    static ClientSingleton* p_instance;          /**< Указатель на экземпляр Singleton */
+    static ClientSingletonDestroyer destroyer;   /**< Объект-разрушитель */
+    QTcpSocket* socket;                          /**< Сокет для соединения с сервером */
+
 protected:
-    ClientSingleton(); //соед с сервером
-    ~ClientSingleton(); // закрыть соед
-    ClientSingleton(const ClientSingleton&) = delete;
-    ClientSingleton& operator=(const ClientSingleton&) = delete;
+    /**
+     * @brief Конструктор по умолчанию. Устанавливает соединение с сервером.
+     */
+    ClientSingleton();
+
+    /**
+     * @brief Деструктор. Закрывает соединение с сервером.
+     */
+    ~ClientSingleton();
+
+    ClientSingleton(const ClientSingleton&) = delete;             /**< Запрещено копирование */
+    ClientSingleton& operator=(const ClientSingleton&) = delete;  /**< Запрещено присваивание */
 
     friend class ClientSingletonDestroyer;
 
 public:
+    /**
+     * @brief Получить экземпляр Singleton.
+     * @return Ссылка на экземпляр ClientSingleton.
+     */
     static ClientSingleton& getInstance();
-    QByteArray send_msg(QStringList);
+
+    /**
+     * @brief Отправляет сообщение серверу.
+     * @param list Список строк с данными для отправки.
+     * @return Ответ от сервера в виде QByteArray.
+     */
+    QByteArray send_msg(QStringList list);
+
 public slots:
+    /**
+     * @brief Слот вызывается при успешном соединении с сервером.
+     */
     void slot_connected();
+
+    /**
+     * @brief Слот вызывается при получении данных от сервера.
+     */
     void slot_readyRead();
 };
 
-
-
-
-
-
-
 #endif // SINGLETON_H

client/add_product.h

@@ -3,31 +3,64 @@
 
 #include <QWidget>
 #include <QMessageBox>
+
 namespace Ui {
 class AddProductWindow;
 }
 
+/**
+ * @brief Класс окна для добавления нового продукта.
+ *
+ * Этот класс предоставляет пользовательский интерфейс для ввода информации
+ * о продукте (название, белки, жиры, углеводы, вес, цена, тип) и отправки этих данных.
+ */
 class AddProductWindow : public QWidget
 {
     Q_OBJECT
 
 public:
+    /**
+     * @brief Конструктор окна добавления продукта.
+     * @param parent Родительский виджет.
+     */
     explicit AddProductWindow(QWidget *parent = nullptr);
-    ~AddProductWindow();
-
 
-private:
-    Ui::AddProductWindow *ui;
+    /**
+     * @brief Деструктор.
+     */
+    ~AddProductWindow();
 
 signals:
+    /**
+     * @brief Сигнал, испускаемый после успешного добавления продукта.
+     * @param name Название продукта.
+     * @param proteins Количество белков.
+     * @param fats Количество жиров.
+     * @param carbs Количество углеводов.
+     * @param weight Вес продукта.
+     * @param cost Стоимость продукта.
+     * @param type Тип продукта.
+     */
     void productAdded(QString name, int proteins, int fats, int carbs, int weight, int cost, int type);
 
-
 public slots:
+    /**
+     * @brief Очистка всех полей ввода.
+     */
     void clear();
+
+    /**
+     * @brief Отображение окна добавления продукта.
+     */
     void slot_show();
 
+private:
+    Ui::AddProductWindow *ui; /**< Указатель на интерфейс UI. */
+
 private slots:
+    /**
+     * @brief Обработчик нажатия кнопки добавления продукта.
+     */
     void on_add_clicked();
 };
 

client/authregwindow.h

@@ -4,34 +4,75 @@
 #include <QMainWindow>
 #include "functions_for_client.h"
 
-
 QT_BEGIN_NAMESPACE
 namespace Ui {
 class AuthRegWindow;
 }
 QT_END_NAMESPACE
 
+/**
+ * @brief Класс окна авторизации и регистрации.
+ *
+ * Этот класс реализует окно для входа в систему и создания нового аккаунта.
+ * Содержит обработчики для переключения между формами, а также подтверждения входа/регистрации.
+ */
 class AuthRegWindow : public QMainWindow
 {
     Q_OBJECT
 
 public:
+    /**
+     * @brief Конструктор окна авторизации/регистрации.
+     * @param parent Родительский виджет.
+     */
     AuthRegWindow(QWidget *parent = nullptr);
+
+    /**
+     * @brief Деструктор.
+     */
     ~AuthRegWindow();
 
 private slots:
+    /**
+     * @brief Обработчик нажатия кнопки "Регистрация".
+     * Переключает окно в режим регистрации.
+     */
     void on_toRegButton_clicked();
 
+    /**
+     * @brief Обработчик подтверждения регистрации.
+     * Отправляет данные нового пользователя на сервер.
+     */
     void on_regButton_clicked();
 
+    /**
+     * @brief Обработчик подтверждения входа.
+     * Отправляет данные пользователя на сервер для авторизации.
+     */
     void on_loginButton_clicked();
 
 signals:
+    /**
+     * @brief Сигнал об успешной авторизации.
+     * @param id Идентификатор пользователя.
+     * @param login Логин пользователя.
+     * @param email Электронная почта пользователя.
+     */
     void auth_ok(QString id, QString login, QString email);
 
 private:
-    Ui::AuthRegWindow *ui;
-    void change_type_to_reg(bool);
+    Ui::AuthRegWindow *ui; /**< Указатель на интерфейс. */
+
+    /**
+     * @brief Вспомогательная функция переключения режима окна.
+     * @param to_reg Если true — включается режим регистрации.
+     */
+    void change_type_to_reg(bool to_reg);
+
+    /**
+     * @brief Очистка всех полей ввода.
+     */
     void clear();
 };
+
 #endif // AUTHREGWINDOW_H