docs

Author: pavel-cpp

source/interfaces/database-settings/database_settings.h

@@ -29,37 +29,89 @@ QT_BEGIN_NAMESPACE
 namespace Ui { class DatabaseSettings; }
 QT_END_NAMESPACE
 
+/**
+ * @class DatabaseSettings
+ * @brief The DatabaseSettings class provides a dialog for managing database settings.
+ *
+ * This class provides a QDialog with fields for the user to input database settings such as host, port, username, password, database, and schema.
+ * It also provides buttons to test the connection and save the settings.
+ */
 class DatabaseSettings : public QDialog {
 Q_OBJECT
 
 public:
+    /**
+     * @brief Construct a new Database Settings object
+     *
+     * @param database_settings_ Reference to a Database object where the settings will be stored.
+     * @param parent Pointer to the parent QWidget. Default is nullptr.
+     */
     explicit DatabaseSettings(Models::Database &database_settings_, QWidget *parent = nullptr);
 
+    /**
+     * @brief Destroy the Database Settings object
+     */
     ~DatabaseSettings() override;
 
 private slots:
 
+    /**
+     * @brief Slot for handling changes in the host field.
+     *
+     * @param text The new text in the host field.
+     */
     void on_host_edit_textChanged(const QString &text);
 
+    /**
+     * @brief Slot for handling changes in the port field.
+     *
+     * @param text The new text in the port field.
+     */
     void on_port_edit_textChanged(const QString &text);
 
+    /**
+     * @brief Slot for handling changes in the username field.
+     *
+     * @param text The new text in the username field.
+     */
     void on_username_edit_textChanged(const QString &text);
 
+    /**
+     * @brief Slot for handling changes in the password field.
+     *
+     * @param text The new text in the password field.
+     */
     void on_password_edit_textChanged(const QString &text);
 
+    /**
+     * @brief Slot for handling changes in the database field.
+     *
+     * @param text The new text in the database field.
+     */
     void on_database_edit_textChanged(const QString &text);
 
+    /**
+     * @brief Slot for handling changes in the schema field.
+     *
+     * @param text The new text in the schema field.
+     */
     void on_schema_edit_textChanged(const QString &text);
 
+    /**
+     * @brief Slot for handling the test button click event.
+     */
     void on_test_button_clicked();
 
+    /**
+     * @brief Slot for handling the save button click event.
+     */
     void on_save_button_clicked();
 
 private:
 
-    Ui::DatabaseSettings *ui;
+    Ui::DatabaseSettings *ui; ///< Pointer to the UI object for this dialog.
 
-    Models::Database &database_settings_;
-    Models::Database database_settings_buffer_;
+    Models::Database &database_settings_; ///< Reference to the Database object where the settings are stored.
+    Models::Database database_settings_buffer_; ///< Buffer for storing the current settings while they are being edited.
 
 };

source/interfaces/font-editor/font_editor.h

@@ -30,37 +30,91 @@ namespace Ui {
     class FontEditor;
 }
 
+/**
+ * @class FontEditor
+ * @brief The FontEditor class provides a dialog for managing font settings.
+ *
+ * This class provides a QDialog with fields for the user to input font settings such as color, font type, boldness, and size.
+ * It also provides a save button to store the settings.
+ */
 class FontEditor : public QDialog {
 Q_OBJECT
 
 public:
+    /**
+     * @brief Construct a new Font Editor object
+     *
+     * @param font_settings Reference to a FontSettings object where the settings will be stored.
+     * @param parent Pointer to the parent QWidget. Default is nullptr.
+     */
     explicit FontEditor(Models::FontSettings &font_settings, QWidget *parent = nullptr);
 
+    /**
+     * @brief Destroy the Font Editor object
+     */
     ~FontEditor() override;
 
 private slots:
 
+    /**
+     * @brief Slot for handling changes in the red color slider.
+     *
+     * @param value The new value of the red color slider.
+     */
     void on_red_slider_valueChanged(int value);
 
+    /**
+     * @brief Slot for handling changes in the green color slider.
+     *
+     * @param value The new value of the green color slider.
+     */
     void on_green_slider_valueChanged(int value);
 
+    /**
+     * @brief Slot for handling changes in the blue color slider.
+     *
+     * @param value The new value of the blue color slider.
+     */
     void on_blue_slider_valueChanged(int value);
 
+    /**
+     * @brief Slot for handling changes in the font type combo box.
+     *
+     * @param font The new font selected in the combo box.
+     */
     void on_font_combo_box_currentFontChanged(const QFont &font);
 
+    /**
+     * @brief Slot for handling changes in the boldness check box.
+     *
+     * @param value The new state of the boldness check box.
+     */
     void on_bold_check_box_stateChanged(int value);
 
+    /**
+     * @brief Slot for handling changes in the font size spin box.
+     *
+     * @param value The new value of the font size spin box.
+     */
     void on_size_spin_box_valueChanged(int value);
 
+    /**
+     * @brief Slot for handling the save button click event.
+     *
+     * This function saves the current settings to the font_settings_ object and closes the dialog.
+     */
     void on_save_button_clicked();
 
 private:
 
+    /**
+     * @brief Load the current font settings into the UI.
+     */
     void LoadFontSettings();
 
-    Models::FontSettings font_settings_buffer_;
+    Models::FontSettings font_settings_buffer_; ///< Buffer for storing the current settings while they are being edited.
 
-    Models::FontSettings &font_settings_;
+    Models::FontSettings &font_settings_; ///< Reference to the FontSettings object where the settings are stored.
 
-    Ui::FontEditor *ui;
-};
+    Ui::FontEditor *ui; ///< Pointer to the UI object for this dialog.
+};

source/interfaces/mainwindow/mainwindow.h

@@ -40,70 +40,153 @@ QT_BEGIN_NAMESPACE
 namespace Ui { class MainWindow; }
 QT_END_NAMESPACE
 
+/**
+ * @class MainWindow
+ * @brief The MainWindow class provides the main application window.
+ *
+ * This class provides a QMainWindow with various menu actions for managing the application's functionality.
+ * It also manages the database and image display.
+ */
 class MainWindow : public QMainWindow {
 Q_OBJECT
 
 public:
+    /**
+     * @brief Construct a new Main Window object
+     *
+     * @param parent Pointer to the parent QWidget. Default is nullptr.
+     */
     explicit MainWindow(QWidget *parent = nullptr);
 
+    /**
+     * @brief Destroy the Main Window object
+     */
     ~MainWindow() override;
 
 private slots:
 
+    /**
+     * @brief Slot for handling the save_some_images action.
+     */
     void on_save_some_images_triggered();
 
+    /**
+     * @brief Slot for handling the copy action.
+     */
     void on_copy_triggered();
 
+    /**
+     * @brief Slot for handling the settings action.
+     */
     void on_settings_triggered();
 
+    /**
+     * @brief Slot for handling the save_image action.
+     */
     void on_save_image_triggered();
 
+    /**
+     * @brief Slot for handling the print action.
+     */
     void on_print_triggered();
 
+    /**
+     * @brief Slot for handling changes in the database search field.
+     */
     void on_database_search_textChanged();
 
+    /**
+     * @brief Slot for handling the show_database action.
+     */
     void on_show_database_triggered();
 
+    /**
+     * @brief Slot for handling the hide_database action.
+     */
     void on_hide_database_triggered();
 
+    /**
+     * @brief Slot for handling the show_image action.
+     */
     void on_show_image_triggered();
 
+    /**
+     * @brief Slot for handling the hide_image action.
+     */
     void on_hide_image_triggered();
 
-    void on_database_table_view_clicked(const QModelIndex &);
+    /**
+     * @brief Slot for handling clicks on the database table view.
+     *
+     * @param index The index of the clicked item.
+     */
+    void on_database_table_view_clicked(const QModelIndex &index);
 
+    /**
+     * @brief Slot for handling the image_scale_up action.
+     */
     void on_image_scale_up_triggered();
 
+    /**
+     * @brief Slot for handling the image_scale_down action.
+     */
     void on_image_scale_down_triggered();
 
+    /**
+     * @brief Slot for handling the refresh_database_action.
+     */
     void on_refresh_database_action_triggered();
 
+    /**
+     * @brief Slot for handling the insert_single_record action.
+     */
     void on_insert_single_record_triggered();
 
+    /**
+     * @brief Slot for handling the insert_same_records action.
+     */
     void on_insert_same_records_triggered();
 
+    /**
+     * @brief Slot for handling the clear_database action.
+     */
     void on_clear_database_triggered();
 
+    /**
+     * @brief Slot for handling changes in the database table view data.
+     *
+     * @param index The index of the changed item.
+     */
     void database_table_view_data_changed(const QModelIndex &index);
 
 private:
 
-    Logger log_ = Logger("logs");
+    Logger log_ = Logger("logs"); ///< Logger object for logging application events.
 
-    QSize current_image_size_;
+    QSize current_image_size_; ///< Current size of the displayed image.
 
-    std::array<TextPainter::ContentTemplate, 3> items_;
+    std::array<TextPainter::ContentTemplate, 3> items_; ///< Array of content templates for the TextPainter.
 
-    TextPainter text_painter_;
-    SettingsManager settings_manager_;
+    TextPainter text_painter_; ///< TextPainter object for generating images.
 
-    Database database_;
-    std::unique_ptr<QSqlTableModel> table_model_;
+    SettingsManager settings_manager_; ///< SettingsManager object for managing application settings.
 
-    std::unique_ptr<Ui::MainWindow> ui;
+    Database database_; ///< Database object for managing the application's database.
 
+    std::unique_ptr<QSqlTableModel> table_model_; ///< QSqlTableModel object for managing the database table view.
+
+    std::unique_ptr<Ui::MainWindow> ui; ///< Pointer to the UI object for this window.
+
+    /**
+     * @brief Redraw the displayed image.
+     */
     void ReDrawImage();
 
+    /**
+     * @brief Set the contents of the TextPainter based on the given index.
+     *
+     * @param index The index of the item to use for setting the contents.
+     */
     void SetContents(const QModelIndex &index);
 
-};
+};