1 files changed, 42 insertions, 16 deletions

diff --git a/src/ui/data_struct/SoftwareVersion.h b/src/ui/struct/SoftwareVersion.h
index be646b71..04300053 100644
--- a/src/ui/data_struct/SoftwareVersion.h
+++ b/src/ui/struct/SoftwareVersion.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,19 +8,21 @@
  * 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
  *
  */
 
@@ -28,28 +32,50 @@
 #include <boost/date_time.hpp>
 
 namespace GpgFrontend::UI {
+/**
+ * @brief
+ *
+ */
 struct SoftwareVersion {
-  std::string latest_version;
-  std::string current_version;
-  bool latest_prerelease = false;
-  bool latest_draft = false;
-  bool current_prerelease = false;
-  bool current_draft = false;
-  bool load_info_done = false;
-  bool current_version_found = false;
-  std::string publish_date;
-  std::string release_note;
+  std::string latest_version;          ///<
+  std::string current_version;         ///<
+  bool latest_prerelease = false;      ///<
+  bool latest_draft = false;           ///<
+  bool current_prerelease = false;     ///<
+  bool current_draft = false;          ///<
+  bool load_info_done = false;         ///<
+  bool current_version_found = false;  ///<
+  std::string publish_date;            ///<
+  std::string release_note;            ///<
 
+  /**
+   * @brief
+   *
+   * @return true
+   * @return false
+   */
   [[nodiscard]] bool NeedUpgrade() const {
     return load_info_done && !latest_prerelease && !latest_draft &&
            current_version < latest_version;
   }
 
+  /**
+   * @brief
+   *
+   * @return true
+   * @return false
+   */
   [[nodiscard]] bool VersionWithDrawn() const {
     return load_info_done && !current_version_found && current_prerelease &&
            !current_draft;
   }
 
+  /**
+   * @brief
+   *
+   * @return true
+   * @return false
+   */
   [[nodiscard]] bool CurrentVersionReleased() const {
     return load_info_done && current_version_found;
   }