Clarify comment

mixxxdj · Jul 31, 2022 · a607187 · a607187
1 parent c848725
commit a607187
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 7 deletions.
diff --git a/src/library/browse/browsethread.cpp b/src/library/browse/browsethread.cpp
@@ -162,7 +162,8 @@ void BrowseThread::populateModel() {
                 thisPath.token());
         {
             mixxx::TrackMetadata trackMetadata;
-            constexpr auto resetMissingTagMetadata = false; // no effect
+            // Both resetMissingTagMetadata = false/true have the same effect
+            constexpr auto resetMissingTagMetadata = false;
             SoundSourceProxy::importTrackMetadataAndCoverImageFromFile(
                     fileAccess,
                     &trackMetadata,

diff --git a/src/library/coverartutils.cpp b/src/library/coverartutils.cpp
@@ -46,7 +46,8 @@ QString CoverArtUtils::supportedCoverArtExtensionsRegex() {
 QImage CoverArtUtils::extractEmbeddedCover(
         mixxx::FileAccess trackFileAccess) {
     QImage image;
-    constexpr auto resetMissingTagMetadata = false; // no effect
+    // Both resetMissingTagMetadata = false/true have the same effect
+    constexpr auto resetMissingTagMetadata = false;
     SoundSourceProxy::importTrackMetadataAndCoverImageFromFile(
             std::move(trackFileAccess),
             nullptr,

diff --git a/src/test/coverartcache_test.cpp b/src/test/coverartcache_test.cpp
@@ -13,7 +13,8 @@ class CoverArtCacheTest : public LibraryTest, public CoverArtCache {
   protected:
     void loadCoverFromMetadata(const QString& trackLocation) {
         QImage img;
-        constexpr auto resetMissingTagMetadata = false; // no effect
+        // Both resetMissingTagMetadata = false/true have the same effect
+        constexpr auto resetMissingTagMetadata = false;
         SoundSourceProxy::importTrackMetadataAndCoverImageFromFile(
                 mixxx::FileAccess(mixxx::FileInfo(trackLocation)),
                 nullptr,

diff --git a/src/test/metadatatest.cpp b/src/test/metadatatest.cpp
@@ -46,7 +46,8 @@ class MetadataTest : public testing::Test {
         pFrame.release();
 
         mixxx::TrackMetadata trackMetadata;
-        constexpr auto resetMissingTagMetadata = false; // no effect
+        // Both resetMissingTagMetadata = false/true have the same effect
+        constexpr auto resetMissingTagMetadata = false;
         mixxx::taglib::id3v2::importTrackMetadataFromTag(
                 &trackMetadata, tag, resetMissingTagMetadata);
 
@@ -130,7 +131,8 @@ TEST_F(MetadataTest, ID3v2Year) {
                 mixxx::taglib::id3v2::exportTrackMetadataIntoTag(&tag, trackMetadata);
             }
             mixxx::TrackMetadata trackMetadata;
-            constexpr auto resetMissingTagMetadata = false; // no effect
+            // Both resetMissingTagMetadata = false/true have the same effect
+            constexpr auto resetMissingTagMetadata = false;
             mixxx::taglib::id3v2::importTrackMetadataFromTag(
                     &trackMetadata, tag, resetMissingTagMetadata);
             if (4 > majorVersion) {

diff --git a/src/test/soundproxy_test.cpp b/src/test/soundproxy_test.cpp
@@ -290,7 +290,8 @@ TEST_F(SoundSourceProxyTest, TOAL_TPE2) {
             getTestDir().filePath(QStringLiteral("id3-test-data/TOAL_TPE2.mp3")));
     SoundSourceProxy proxy(pTrack);
     mixxx::TrackMetadata trackMetadata;
-    constexpr auto resetMissingTagMetadata = false; // no effect
+    // Both resetMissingTagMetadata = false/true have the same effect
+    constexpr auto resetMissingTagMetadata = false;
     EXPECT_EQ(mixxx::MetadataSource::ImportResult::Succeeded,
             proxy.importTrackMetadataAndCoverImage(
                          &trackMetadata, nullptr, resetMissingTagMetadata)

diff --git a/src/track/track.cpp b/src/track/track.cpp
@@ -1582,7 +1582,8 @@ ExportTrackMetadataResult Track::exportMetadata(
     // Otherwise floating-point values like the bpm value might become
     // inconsistent with the actual value stored by the beat grid!
     mixxx::TrackMetadata normalizedFromRecord;
-    constexpr auto resetMissingTagMetadata = false; // true would have no effect
+    // Both resetMissingTagMetadata = false/true have the same effect
+    constexpr auto resetMissingTagMetadata = false;
     if ((metadataSource.importTrackMetadataAndCoverImage(&importedFromFile,
                                nullptr,
                                resetMissingTagMetadata)