From 8b37a297d414282258a44b4106c8e437a4ccfc69 Mon Sep 17 00:00:00 2001
From: Mm2PL <miau@mail.kotmisia.pl>
Date: Tue, 14 Feb 2023 11:55:44 +0100
Subject: [PATCH] Add comments to PluginMeta definition

---
 src/controllers/plugins/Plugin.hpp | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/src/controllers/plugins/Plugin.hpp b/src/controllers/plugins/Plugin.hpp
index 5f96af744..8a35b3312 100644
--- a/src/controllers/plugins/Plugin.hpp
+++ b/src/controllers/plugins/Plugin.hpp
@@ -19,17 +19,30 @@ struct lua_State;
 namespace chatterino {
 
 struct PluginMeta {
-    // required fields
+    // for more info on these fields see docs/plugin-info.schema.json
+
+    // display name of the plugin
     QString name;
+
+    // description shown to the user
     QString description;
+
+    // plugin authors shown to the user
     std::vector<QString> authors;
+
+    // license name
     QString license;
+
+    // version of the plugin
     semver::version version;
 
-    // optional
+    // optionally a homepage link
     QString homepage;
+
+    // optionally tags that might help in searching for the plugin
     std::vector<QString> tags;
 
+    // errors that occurred while parsing info.json
     std::vector<QString> errors;
 
     bool isValid() const