Add comment indicating location is mandatory, list possible locations, rename SettingsTabBar to SettingsTab for consistency

This commit is contained in:
Adam Honse
2021-08-29 14:32:19 -05:00
parent 524fd057fe
commit 702be2401b
2 changed files with 10 additions and 8 deletions

View File

@@ -33,7 +33,9 @@ struct OpenRGBPluginInfo
/*-------------------------------------------------------------------------------------------------*\
| Plugin Tab Configuration |
\*-------------------------------------------------------------------------------------------------*/
std::string Location; /* Plugin tab location, such as "TopTabBar" */
std::string Location; /* Plugin tab location. This field is mandatory */
/* Options are "TopTabBar", "DevicesTab", */
/* "InformationTab", or "SettingsTab" */
std::string Label; /* Plugin tab label string */
std::string TabIconString; /* Plugin tab icon string, leave empty to use custom */
QImage TabIcon; /* Custom tab icon image (displayed 16x16) */