TrackDAO: Clarify why internal, static methods must be public

mixxxdj · Aug 17, 2021 · f4918db · f4918db
1 parent 32d113b
commit f4918db
Showing 1 changed file with 12 additions and 3 deletions.
diff --git a/src/library/dao/trackdao.h b/src/library/dao/trackdao.h
@@ -81,11 +81,20 @@ class TrackDAO : public QObject, public virtual DAO, public virtual GlobalTrackC
     bool updatePlayCounterFromPlayedHistory(
             const QSet<TrackId>& trackIds) const;
 
-    /// Ugly workaround, don't use!!!
+    /// Don't use even if public!!! Ugly workaround for C++ visibility restrictions.
+    /// This method is invoked by a free function that needs to access
+    /// a private Track member that only TrackDAO is allowed to access
+    /// as a friend.
     static void setTrackGenreInternal(Track* pTrack, const QString& genre);
-    /// Ugly workaround, don't use!!!
+    /// Don't use even if public!!! Ugly workaround for C++ visibility restrictions.
+    /// This method is invoked by a free function that needs to access
+    /// a private TrackRecord member that only TrackDAO is allowed to
+    /// access as a friend.
     static void setTrackHeaderParsedInternal(Track* pTrack, bool headerParsed);
-    /// Ugly workaround, don't use!!!
+    /// Don't use even if public!!! Ugly workaround for C++ visibility restrictions.
+    /// This method is invoked by a free function that needs to access
+    /// private TrackRecord member that only TrackDAO is allowed to
+    /// access as a friend.
     static bool getTrackHeaderParsedInternal(const mixxx::TrackRecord& trackRecord);
 
   signals: