From 7e1e1e2e67766e0541666e09a092e3fc27e893b3 Mon Sep 17 00:00:00 2001
From: Simon Schneegans <code@simonschneegans.de>
Date: Mon, 10 Jan 2022 16:19:20 +0100
Subject: [PATCH] :memo: Add some more comments

---
 extension.js | 1 +
 prefs.js     | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/extension.js b/extension.js
index 07e7ca5..172755c 100644
--- a/extension.js
+++ b/extension.js
@@ -24,6 +24,7 @@ const Me             = imports.misc.extensionUtils.getCurrentExtension();
 const utils          = Me.imports.src.utils;
 const FireEffect     = Me.imports.src.FireEffect.FireEffect;
 
+// New effects must be registered here and in prefs.js.
 const ALL_EFFECTS = [
   Me.imports.src.FireEffect.FireEffect,
   Me.imports.src.MatrixEffect.MatrixEffect,
diff --git a/prefs.js b/prefs.js
index 8a1eebe..4d67e1f 100644
--- a/prefs.js
+++ b/prefs.js
@@ -19,6 +19,7 @@ const ExtensionUtils = imports.misc.extensionUtils;
 const Me             = imports.misc.extensionUtils.getCurrentExtension();
 const utils          = Me.imports.src.utils;
 
+// New effects must be registered here and in extension.js.
 const ALL_EFFECTS = [
   Me.imports.src.FireEffect.FireEffect,
   Me.imports.src.MatrixEffect.MatrixEffect,
@@ -140,10 +141,13 @@ var PreferencesDialog = class PreferencesDialog {
 
   // -------------------------------------------------------------------- public interface
 
+  // Returns the internally used Gtk.Builder. Effects can use this to modify the UI of the
+  // preferences dialog.
   getBuilder() {
     return this._builder;
   }
 
+  // Returns a Gio.Settings object for this extension.
   getSettings() {
     return this._settings;
   }