mirror of
https://github.com/Chatterino/chatterino2.git
synced 2024-11-21 22:24:07 +01:00
Add comments to PluginMeta definition
This commit is contained in:
parent
e19b96026d
commit
8b37a297d4
1 changed files with 15 additions and 2 deletions
|
@ -19,17 +19,30 @@ struct lua_State;
|
||||||
namespace chatterino {
|
namespace chatterino {
|
||||||
|
|
||||||
struct PluginMeta {
|
struct PluginMeta {
|
||||||
// required fields
|
// for more info on these fields see docs/plugin-info.schema.json
|
||||||
|
|
||||||
|
// display name of the plugin
|
||||||
QString name;
|
QString name;
|
||||||
|
|
||||||
|
// description shown to the user
|
||||||
QString description;
|
QString description;
|
||||||
|
|
||||||
|
// plugin authors shown to the user
|
||||||
std::vector<QString> authors;
|
std::vector<QString> authors;
|
||||||
|
|
||||||
|
// license name
|
||||||
QString license;
|
QString license;
|
||||||
|
|
||||||
|
// version of the plugin
|
||||||
semver::version version;
|
semver::version version;
|
||||||
|
|
||||||
// optional
|
// optionally a homepage link
|
||||||
QString homepage;
|
QString homepage;
|
||||||
|
|
||||||
|
// optionally tags that might help in searching for the plugin
|
||||||
std::vector<QString> tags;
|
std::vector<QString> tags;
|
||||||
|
|
||||||
|
// errors that occurred while parsing info.json
|
||||||
std::vector<QString> errors;
|
std::vector<QString> errors;
|
||||||
|
|
||||||
bool isValid() const
|
bool isValid() const
|
||||||
|
|
Loading…
Reference in a new issue