Merge branch 'main' of git.sr.ht:~jacqueline/tangara-fw

1 files changed, 10 insertions, 0 deletions

diff --git a/src/ui/include/screen.hpp b/src/ui/include/screen.hpp
index 7ff06fbd..13b92a09 100644
--- a/src/ui/include/screen.hpp
+++ b/src/ui/include/screen.hpp
@@ -15,14 +15,24 @@
 
 namespace ui {
 
+/*
+ * Base class for ever discrete screen in the app. Provides a consistent
+ * interface that can be used for transitioning between screens, adding them to
+ * back stacks, etc.
+ */
 class Screen {
  public:
   Screen() : root_(lv_obj_create(NULL)), group_(lv_group_create()) {}
+
   virtual ~Screen() {
     lv_obj_del(root_);
     lv_group_del(group_);
   }
 
+  /*
+   * Called periodically to allow the screen to update itself, e.g. to handle
+   * std::futures that are still loading in.
+   */
   virtual auto Tick() -> void {}
 
   auto root() -> lv_obj_t* { return root_; }