1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-10-20 17:41:13 +02:00

Comments which IdentInterface functions return persistent values

This commit is contained in:
Paul Licameli
2018-02-04 16:25:08 -05:00
parent 575070e9ae
commit 942175f27b
5 changed files with 23 additions and 1 deletions

View File

@@ -64,8 +64,11 @@ public:
virtual ~EffectIdentInterface() {};
virtual EffectType GetType() = 0;
// Returns a string for internal uses only that may persist in config files:
// This string persists in configuration files
// So config compatibility will break if it is changed across Audacity versions
virtual wxString GetFamilyId() = 0;
// Returns a user-visible string:
virtual wxString GetFamilyName() = 0;

View File

@@ -51,11 +51,15 @@ public:
// These should return an untranslated value
virtual wxString GetPath() = 0;
// This string persists in configuration files
// So config compatibility will break if it is changed across Audacity versions
virtual wxString GetSymbol() = 0;
// These should return an untranslated value whose translation
// will be determined at runtime (if available)
virtual wxString GetName() = 0;
// This string persists in configuration files
// So config compatibility will break if it is changed across Audacity versions
virtual wxString GetVendor() = 0;
virtual wxString GetVersion() = 0;