Added comments

mixxxdj · May 29, 2018 · bbae2ba · bbae2ba
1 parent b87b2bb
commit bbae2ba
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/src/effects/effectmanifest.h b/src/effects/effectmanifest.h
@@ -144,6 +144,8 @@ class EffectManifest final {
                 return QString("Unknown");
         }
     }
+
+    // Use this when showing the string in the GUI
     QString translatedBackendName() {
         switch (m_backendType) {
             case EffectBackendType::BuiltIn:

diff --git a/src/effects/effectsmanager.cpp b/src/effects/effectsmanager.cpp
@@ -70,8 +70,9 @@ EffectsManager::~EffectsManager() {
 
 bool alphabetizeEffectManifests(EffectManifestPointer pManifest1,
                                 EffectManifestPointer pManifest2) {
-    int dNameComp = QString::localeAwareCompare(pManifest1->displayName(), pManifest2->displayName());
+    // Sort built-in effects first before external plugins
     int bNameComp = static_cast<int>(pManifest1->backendType()) - static_cast<int>(pManifest2->backendType());
+    int dNameComp = QString::localeAwareCompare(pManifest1->displayName(), pManifest2->displayName());
     return (bNameComp ? (bNameComp < 0) : (dNameComp < 0));
 }
 

diff --git a/src/effects/effectsmanager.h b/src/effects/effectsmanager.h
@@ -8,8 +8,6 @@
 #include <QScopedPointer>
 #include <QPair>
 
-#include <algorithm>
-
 #include "preferences/usersettings.h"
 #include "control/controlpotmeter.h"
 #include "control/controlpushbutton.h"

diff --git a/src/preferences/dialog/dlgprefeffects.cpp b/src/preferences/dialog/dlgprefeffects.cpp
@@ -62,6 +62,10 @@ void DlgPrefEffects::slotApply() {
     for (EffectProfilePtr profile : m_availableEffectsModel.profiles()) {
         EffectManifestPointer pManifest = profile->pManifest;
         m_pEffectsManager->setEffectVisibility(pManifest, profile->bIsVisible);
+
+        // Effects from different backends can have same Effect IDs.
+        // Add backend name to group to uniquely identify those effects.
+        // Use untranslated value to keep the group language independent.
         m_pConfig->set(ConfigKey("[Visible " + pManifest->backendName() + " Effects]", pManifest->id()), 
                        ConfigValue(profile->bIsVisible));
     }