Merge pull request #49 from saturneric/develop-2.0.5

v2.0.5

1 files changed, 101 insertions, 17 deletions

diff --git a/src/ui/Wizard.h b/src/ui/dialog/Wizard.h
index 7145d310..eb093550 100644
--- a/src/ui/Wizard.h
+++ b/src/ui/dialog/Wizard.h
@@ -1,4 +1,6 @@
 /**
+ * Copyright (C) 2021 Saturneric
+ *
  * This file is part of GpgFrontend.
  *
  * GpgFrontend is free software: you can redistribute it and/or modify
@@ -6,33 +8,39 @@
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
- * Foobar is distributed in the hope that it will be useful,
+ * GpgFrontend is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with Foobar.  If not, see <https://www.gnu.org/licenses/>.
+ * along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The initial version of the source code is inherited from
+ * the gpg4usb project, which is under GPL-3.0-or-later.
  *
- * The initial version of the source code is inherited from gpg4usb-team.
- * Their source code version also complies with GNU General Public License.
+ * All the source code of GpgFrontend was modified and released by
+ * Saturneric<[email protected]> starting on May 12, 2021.
  *
- * The source code version of this software was modified and released
- * by Saturneric<[email protected]> starting on May 12, 2021.
+ * SPDX-License-Identifier: GPL-3.0-or-later
  *
  */
 
 #ifndef WIZARD_H
 #define WIZARD_H
 
-#include "gpg/GpgConstants.h"
+#include "core/GpgConstants.h"
 #include "ui/GpgFrontendUI.h"
 #include "ui/KeyMgmt.h"
-#include "ui/keygen/KeygenDialog.h"
+#include "ui/key_generate/KeygenDialog.h"
 #include "ui/settings/SettingsDialog.h"
 
 namespace GpgFrontend::UI {
 
+/**
+ * @brief
+ *
+ */
 class Wizard : public QWizard {
   Q_OBJECT
   Q_ENUMS(WizardPages)
@@ -40,21 +48,50 @@ class Wizard : public QWizard {
  public:
   enum WizardPages { Page_Intro, Page_Choose, Page_GenKey, Page_Conclusion };
 
+  /**
+   * @brief Construct a new Wizard object
+   *
+   * @param parent
+   */
   explicit Wizard(QWidget* parent = nullptr);
 
  private slots:
-  void slotWizardAccepted();
+  /**
+   * @brief
+   *
+   */
+  void slot_wizard_accepted();
 
  signals:
-  void signalOpenHelp(QString page);
+  /**
+   * @brief
+   *
+   * @param page
+   */
+  void SignalOpenHelp(QString page);
 };
 
+/**
+ * @brief
+ *
+ */
 class IntroPage : public QWizardPage {
   Q_OBJECT
 
  public:
+  /**
+   * @brief Construct a new Intro Page object
+   *
+   * @param parent
+   */
   explicit IntroPage(QWidget* parent = nullptr);
 
+ protected:
+  /**
+   * @brief
+   *
+   * @return int
+   */
   [[nodiscard]] int nextId() const override;
 };
 
@@ -62,42 +99,89 @@ class ChoosePage : public QWizardPage {
   Q_OBJECT
 
  public:
+  /**
+   * @brief Construct a new Choose Page object
+   *
+   * @param parent
+   */
   explicit ChoosePage(QWidget* parent = nullptr);
 
  private slots:
 
-  void slotJumpPage(const QString& page);
-
- private:
+  /**
+   * @brief
+   *
+   * @param page
+   */
+  void slot_jump_page(const QString& page);
+
+ protected:
+  /**
+   * @brief
+   *
+   * @return int
+   */
   [[nodiscard]] int nextId() const override;
 
-  int nextPage;
+  int next_page_;  ///<
 };
 
+/**
+ * @brief
+ *
+ */
 class KeyGenPage : public QWizardPage {
   Q_OBJECT
 
  public:
+  /**
+   * @brief Construct a new Key Gen Page object
+   *
+   * @param parent
+   */
   explicit KeyGenPage(QWidget* parent = nullptr);
 
+  /**
+   * @brief
+   *
+   * @return int
+   */
   [[nodiscard]] int nextId() const override;
 
  private slots:
 
-  void slotGenerateKeyDialog();
+  /**
+   * @brief
+   *
+   */
+  void slot_generate_key_dialog();
 };
 
+/**
+ * @brief
+ *
+ */
 class ConclusionPage : public QWizardPage {
   Q_OBJECT
 
  public:
+  /**
+   * @brief Construct a new Conclusion Page object
+   *
+   * @param parent
+   */
   explicit ConclusionPage(QWidget* parent = nullptr);
 
+  /**
+   * @brief
+   *
+   * @return int
+   */
   [[nodiscard]] int nextId() const override;
 
  private:
-  QCheckBox* dontShowWizardCheckBox;
-  QCheckBox* openHelpCheckBox;
+  QCheckBox* dont_show_wizard_checkbox_;  ///<
+  QCheckBox* open_help_check_box_;        ///<
 };
 
 }  // namespace GpgFrontend::UI