<doc, refactor>(ui): Tidy up part of the code of ui and related parts

1. Rename related entities.
2. Add comments.

1 files changed, 32 insertions, 1 deletions

diff --git a/src/ui/data_struct/SettingsObject.h b/src/ui/data_struct/SettingsObject.h
index af63b74f..3d26ae4b 100644
--- a/src/ui/data_struct/SettingsObject.h
+++ b/src/ui/data_struct/SettingsObject.h
@@ -31,20 +31,51 @@
 
 namespace GpgFrontend::UI {
 
+/**
+ * @brief
+ *
+ */
 class SettingsObject : public nlohmann::json {
  public:
+  /**
+   * @brief Construct a new Settings Object object
+   *
+   * @param settings_name
+   */
   explicit SettingsObject(std::string settings_name);
 
+  /**
+   * @brief Construct a new Settings Object object
+   *
+   * @param _sub_json
+   */
   explicit SettingsObject(nlohmann::json _sub_json, bool);
 
+  /**
+   * @brief Destroy the Settings Object object
+   *
+   */
   ~SettingsObject();
 
+  /**
+   * @brief
+   *
+   * @param key
+   * @param default_value
+   * @return nlohmann::json&
+   */
   nlohmann::json& Check(const std::string& key, nlohmann::json default_value);
 
+  /**
+   * @brief
+   *
+   * @param key
+   * @return SettingsObject
+   */
   SettingsObject Check(const std::string& key);
 
  private:
-  std::string settings_name_;
+  std::string settings_name_;  ///<
 };
 }  // namespace GpgFrontend::UI