1 files changed, 54 insertions, 21 deletions

diff --git a/src/ui/widgets/PlainTextEditorPage.h b/src/ui/widgets/PlainTextEditorPage.h
index 24823c06..f73e2282 100644
--- a/src/ui/widgets/PlainTextEditorPage.h
+++ b/src/ui/widgets/PlainTextEditorPage.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,26 +8,28 @@
  * 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 __EDITORPAGE_H__
 #define __EDITORPAGE_H__
 
-#include "gpg/GpgConstants.h"
+#include "core/GpgConstants.h"
 #include "ui/GpgFrontendUI.h"
 
 class Ui_PlainTextEditor;
@@ -51,19 +55,19 @@ class PlainTextEditorPage : public QWidget {
   /**
    * @details Get the filepath of the currently activated tab.
    */
-  [[nodiscard]] const QString& getFilePath() const;
+  [[nodiscard]] const QString& GetFilePath() const;
 
   /**
    * @details Set filepath of currently activated tab.
    *
    * @param filePath The path to be set
    */
-  void setFilePath(const QString& filePath);
+  void SetFilePath(const QString& filePath);
 
   /**
    * @details Return pointer tp the textedit of the currently activated tab.
    */
-  QPlainTextEdit* getTextPage();
+  QPlainTextEdit* GetTextPage();
 
   /**
    * @details Show additional widget at buttom of currently active tab
@@ -71,32 +75,56 @@ class PlainTextEditorPage : public QWidget {
    * @param widget The widget to be added
    * @param className The name to handle the added widget
    */
-  void showNotificationWidget(QWidget* widget, const char* className);
+  void ShowNotificationWidget(QWidget* widget, const char* className);
 
   /**
    * @details Hide all widgets with the given className
    *
    * @param className The classname of the widgets to hide
    */
-  void closeNoteByClass(const char* className);
+  void CloseNoteByClass(const char* className);
 
+  /**
+   * @brief
+   *
+   */
   void ReadFile();
 
+  /**
+   * @brief
+   *
+   * @return true
+   * @return false
+   */
   [[nodiscard]] bool ReadDone() const { return this->read_done_; }
 
+  /**
+   * @brief
+   *
+   */
   void PrepareToDestroy();
 
  private:
-  std::shared_ptr<Ui_PlainTextEditor> ui;
-  QString full_file_path_; /** The path to the file handled in the tab */
-  bool signMarked{}; /** true, if the signed header is marked, false if not */
-  bool read_done_ = false;
-  QThread* read_thread_ = nullptr;
-  bool binary_mode_ = false;
-  size_t read_bytes_ = 0;
+  std::shared_ptr<Ui_PlainTextEditor> ui_;  ///<
+  QString full_file_path_;  ///< The path to the file handled in the tab
+  bool sign_marked_{};  ///< true, if the signed header is marked, false if not
+  bool read_done_ = false;          ///<
+  QThread* read_thread_ = nullptr;  ///<
+  bool binary_mode_ = false;        ///<
+  size_t read_bytes_ = 0;           ///<
 
+  /**
+   * @brief
+   *
+   * @param data
+   */
   void detect_encoding(const std::string& data);
 
+  /**
+   * @brief
+   *
+   * @param data
+   */
   void detect_cr_lf(const QString& data);
 
  private slots:
@@ -104,9 +132,14 @@ class PlainTextEditorPage : public QWidget {
   /**
    * @details Format the gpg header in another font-style
    */
-  void slotFormatGpgHeader();
+  void slot_format_gpg_header();
 
-  void slotInsertText(const std::string& data);
+  /**
+   * @brief
+   *
+   * @param data
+   */
+  void slot_insert_text(const std::string& data);
 };
 
 }  // namespace GpgFrontend::UI