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:
@@ -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;
|
||||
|
||||
|
@@ -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;
|
||||
|
||||
|
Reference in New Issue
Block a user