Polish implementation and documentation (#814)

Demo/Sources/Model/Media.swift

@@ -103,8 +103,8 @@ extension Media {
                 )
             },
             trackerAdapters: [
-                DemoTracker.adapter { media in
-                    DemoTracker.Metadata(title: media.title)
+                DemoTracker.adapter { metadata in
+                    DemoTracker.Metadata(title: metadata.title)
                 }
             ]
         )

Sources/Analytics/Analytics.swift

@@ -62,7 +62,9 @@ public class Analytics {
 
     /// Starts analytics with the specified configuration.
     ///
-    /// - Parameter configuration: The configuration to use.
+    /// - Parameters:
+    ///   - configuration: The configuration to use.
+    ///   - dataSource: The data source to use.
     ///
     /// This method must be called from your `UIApplicationDelegate.application(_:didFinishLaunchingWithOptions:)`
     /// delegate method implementation, otherwise the behavior is undefined.

Sources/Analytics/CommandersAct/CommandersActEvent.swift

@@ -16,10 +16,7 @@ public struct CommandersActEvent {
     ///   - labels: Additional information associated with the event.
     ///
     /// Custom labels which might accidentally override official labels will be ignored.
-    public init(
-        name: String,
-        labels: [String: String] = [:]
-    ) {
+    public init(name: String, labels: [String: String] = [:]) {
         assert(!name.isBlank, "A name is required")
         self.name = name
         self.labels = labels

Sources/Analytics/CommandersAct/CommandersActGlobals.swift

@@ -11,7 +11,7 @@ public struct CommandersActGlobals {
     /// Creates Commanders Act global labels.
     /// 
     /// - Parameters:
-    ///   - consentServices: The list of service allowed.
+    ///   - consentServices: The list of services for which the user provided consent.
     ///   - labels: Additional information associated with the global labels.
     public init(consentServices: [String], labels: [String: String]) {
         self.labels = labels.merging([

Sources/Analytics/CommandersAct/CommandersActPageView.swift

@@ -15,7 +15,7 @@ public struct CommandersActPageView {
     /// 
     /// - Parameters:
     ///   - name: The page name.
-    ///   - type: The page type (e.g. Article).
+    ///   - type: The page type (e.g. _Article_).
     ///   - labels: Additional information associated with the page view.
     ///   - levels: The page levels.
     ///

Sources/Analytics/CommandersAct/CommandersActService.swift

@@ -26,17 +26,18 @@ final class CommandersActService {
 
     func start(with configuration: Analytics.Configuration) {
         vendor = configuration.vendor
-        guard let serverSide = ServerSide(siteID: 3666, andSourceKey: configuration.sourceKey) else { return }
-        serverSide.addPermanentData("app_library_version", withValue: Analytics.version)
-        serverSide.addPermanentData("navigation_app_site_name", withValue: configuration.appSiteName)
-        serverSide.addPermanentData("navigation_device", withValue: Self.device())
-        serverSide.enableRunningInBackground()
+
+        if let serverSide = ServerSide(siteID: 3666, andSourceKey: configuration.sourceKey) {
+            serverSide.addPermanentData("app_library_version", withValue: Analytics.version)
+            serverSide.addPermanentData("navigation_app_site_name", withValue: configuration.appSiteName)
+            serverSide.addPermanentData("navigation_device", withValue: Self.device())
+            serverSide.enableRunningInBackground()
+            self.serverSide = serverSide
+        }
 
         // Use the legacy V4 identifier as unique identifier in V5.
         TCDevice.sharedInstance().sdkID = TCPredefinedVariables.sharedInstance().uniqueIdentifier()
         TCPredefinedVariables.sharedInstance().useLegacyUniqueIDForAnonymousID()
-
-        self.serverSide = serverSide
     }
 
     func trackPageView(_ pageView: CommandersActPageView) {

Sources/CoreBusiness/Model/Chapter.swift

@@ -33,7 +33,7 @@ public struct Chapter: Decodable {
 
     /// The chapter image URL.
     ///
-    /// Use `SRGDataProvider.imagePublisher(for:width:)` to obtain a scaled downloadable version.
+    /// Use `DataProvider.imagePublisher(for:width:)` to obtain a scaled downloadable version.
     public let imageUrl: URL
 
     /// The content type.

Sources/Player/UserInterface/RoutePickerView.swift

@@ -46,6 +46,7 @@ public extension RoutePickerView {
         return view
     }
 }
+
 #Preview("Audio") {
     RoutePickerView()
 }

Sources/Player/UserInterface/VisibilityTracker.swift

@@ -38,7 +38,6 @@ import UIKit
 ///    can for example call this method during slider interactions so that the user interface stays visible while the
 ///    user is still moving the slider.
 ///
-///
 /// > Note: For step-by-step integration instructions have a look at the associated <doc:tracking-visibility> tutorial.
 @available(iOS 16, *)
 @available(tvOS, unavailable)

Tests/AnalyticsTests/ComScore/ComScoreTrackerMetadataTests.swift

@@ -53,9 +53,7 @@ final class ComScoreTrackerMetadataTests: ComScoreTestCase {
         let player = Player(item: .simple(
             url: Stream.onDemand.url,
             trackerAdapters: [
-                ComScoreTracker.adapter { _ in
-                    [:]
-                }
+                ComScoreTracker.adapter { _ in [:] }
             ]
         ))
 

Tests/AnalyticsTests/CommandersAct/CommandersActTrackerTests.swift

@@ -35,9 +35,7 @@ final class CommandersActTrackerTests: CommandersActTestCase {
         let player = Player(item: .simple(
             url: Stream.onDemand.url,
             trackerAdapters: [
-                CommandersActTracker.adapter { _ in
-                    [:]
-                }
+                CommandersActTracker.adapter { _ in [:] }
             ]
         ))
 
@@ -133,9 +131,7 @@ final class CommandersActTrackerTests: CommandersActTestCase {
         var player: Player? = Player(item: .simple(
             url: Stream.shortOnDemand.url,
             trackerAdapters: [
-                CommandersActTracker.adapter { _ in
-                    [:]
-                }
+                CommandersActTracker.adapter { _ in [:] }
             ]
         ))
 
@@ -152,9 +148,7 @@ final class CommandersActTrackerTests: CommandersActTestCase {
         let player = Player(item: .simple(
             url: Stream.unavailable.url,
             trackerAdapters: [
-                CommandersActTracker.adapter { _ in
-                    [:]
-                }
+                CommandersActTracker.adapter { _ in [:] }
             ]
         ))
 
@@ -167,9 +161,7 @@ final class CommandersActTrackerTests: CommandersActTestCase {
         let player = Player(item: .simple(
             url: Stream.onDemand.url,
             trackerAdapters: [
-                CommandersActTracker.adapter { _ in
-                    [:]
-                }
+                CommandersActTracker.adapter { _ in [:] }
             ]
         ))
 
@@ -185,9 +177,7 @@ final class CommandersActTrackerTests: CommandersActTestCase {
         let player = Player(item: .simple(
             url: Stream.onDemand.url,
             trackerAdapters: [
-                CommandersActTracker.adapter { _ in
-                    [:]
-                }
+                CommandersActTracker.adapter { _ in [:] }
             ]
         ))