general_frontend: Add documentation for parental controls and ecommerce applets

2 files changed, 32 insertions, 4 deletions

diff --git a/src/core/frontend/applets/general_frontend.cpp b/src/core/frontend/applets/general_frontend.cpp
index e6cb59b64..c30b36de7 100644
--- a/src/core/frontend/applets/general_frontend.cpp
+++ b/src/core/frontend/applets/general_frontend.cpp
@@ -60,10 +60,11 @@ DefaultECommerceApplet::~DefaultECommerceApplet() = default;
 void DefaultECommerceApplet::ShowApplicationInformation(
     std::function<void()> finished, u64 title_id, std::optional<u128> user_id,
     std::optional<bool> full_display, std::optional<std::string> extra_parameter) {
+    const auto value = user_id.value_or(u128{});
     LOG_INFO(Service_AM,
              "Application requested frontend show application information for EShop, "
              "title_id={:016X}, user_id={:016X}{:016X}, full_display={}, extra_parameter={}",
-             title_id, user_id.value_or(u128{})[1], user_id.value_or(u128{})[0],
+             title_id, value[1], value[0],
              full_display.has_value() ? fmt::format("{}", *full_display) : "null",
              extra_parameter.value_or("null"));
     finished();
@@ -72,30 +73,33 @@ void DefaultECommerceApplet::ShowApplicationInformation(
 void DefaultECommerceApplet::ShowAddOnContentList(std::function<void()> finished, u64 title_id,
                                                   std::optional<u128> user_id,
                                                   std::optional<bool> full_display) {
+    const auto value = user_id.value_or(u128{});
     LOG_INFO(Service_AM,
              "Application requested frontend show add on content list for EShop, "
              "title_id={:016X}, user_id={:016X}{:016X}, full_display={}",
-             title_id, user_id.value_or(u128{})[1], user_id.value_or(u128{})[0],
+             title_id, value[1], value[0],
              full_display.has_value() ? fmt::format("{}", *full_display) : "null");
     finished();
 }
 
 void DefaultECommerceApplet::ShowSubscriptionList(std::function<void()> finished, u64 title_id,
                                                   std::optional<u128> user_id) {
+    const auto value = user_id.value_or(u128{});
     LOG_INFO(Service_AM,
              "Application requested frontend show subscription list for EShop, title_id={:016X}, "
              "user_id={:016X}{:016X}",
-             title_id, user_id.value_or(u128{})[1], user_id.value_or(u128{})[0]);
+             title_id, value[1], value[0]);
     finished();
 }
 
 void DefaultECommerceApplet::ShowConsumableItemList(std::function<void()> finished, u64 title_id,
                                                     std::optional<u128> user_id) {
+    const auto value = user_id.value_or(u128{});
     LOG_INFO(
         Service_AM,
         "Application requested frontend show consumable item list for EShop, title_id={:016X}, "
         "user_id={:016X}{:016X}",
-        title_id, user_id.value_or(u128{})[1], user_id.value_or(u128{})[0]);
+        title_id, value[1], value[0]);
     finished();
 }
 
diff --git a/src/core/frontend/applets/general_frontend.h b/src/core/frontend/applets/general_frontend.h
index 616112cfc..4b63f828e 100644
--- a/src/core/frontend/applets/general_frontend.h
+++ b/src/core/frontend/applets/general_frontend.h
@@ -14,10 +14,20 @@ class ParentalControlsApplet {
 public:
     virtual ~ParentalControlsApplet();
 
+    // Prompts the user to enter a PIN and calls the callback with whether or not it matches the
+    // correct PIN. If the bool is passed, and the PIN was recently entered correctly, the frontend
+    // should not prompt and simply return true.
     virtual void VerifyPIN(std::function<void(bool)> finished,
                            bool suspend_future_verification_temporarily) = 0;
+
+    // Prompts the user to enter a PIN and calls the callback for correctness. Frontends can
+    // optionally alert the user that this is to change parental controls settings.
     virtual void VerifyPINForSettings(std::function<void(bool)> finished) = 0;
+
+    // Prompts the user to create a new PIN for pctl and stores it with the service.
     virtual void RegisterPIN(std::function<void()> finished) = 0;
+
+    // Prompts the user to verify the current PIN and then store a new one into pctl.
     virtual void ChangePIN(std::function<void()> finished) = 0;
 };
 
@@ -52,18 +62,32 @@ class ECommerceApplet {
 public:
     virtual ~ECommerceApplet();
 
+    // Shows a page with application icons, description, name, and price.
     virtual void ShowApplicationInformation(std::function<void()> finished, u64 title_id,
                                             std::optional<u128> user_id = {},
                                             std::optional<bool> full_display = {},
                                             std::optional<std::string> extra_parameter = {}) = 0;
+
+    // Shows a page with all of the add on content available for a game, with name, description, and
+    // price.
     virtual void ShowAddOnContentList(std::function<void()> finished, u64 title_id,
                                       std::optional<u128> user_id = {},
                                       std::optional<bool> full_display = {}) = 0;
+
+    // Shows a page with all of the subscriptions (recurring payments) for a game, with name,
+    // description, price, and renewal period.
     virtual void ShowSubscriptionList(std::function<void()> finished, u64 title_id,
                                       std::optional<u128> user_id = {}) = 0;
+
+    // Shows a page with a list of any additional game related purchasable items (DLC,
+    // subscriptions, etc) for a particular game, with name, description, type, and price.
     virtual void ShowConsumableItemList(std::function<void()> finished, u64 title_id,
                                         std::optional<u128> user_id = {}) = 0;
+
+    // Shows the home page of the shop.
     virtual void ShowShopHome(std::function<void()> finished, u128 user_id, bool full_display) = 0;
+
+    // Shows the user settings page of the shop.
     virtual void ShowSettings(std::function<void()> finished, u128 user_id, bool full_display) = 0;
 };