code format and comments

Author: swiftuiux

Sources/swiftui-loop-videoplayer/LoopPlayerView.swift

@@ -121,40 +121,55 @@ fileprivate func errorTpliOS(_ error: VPErrors, _ color: Color, _ fontSize: CGFl
 // MARK: - Representable for macOS
 
 #if os(macOS)
+/// A view representable for macOS to display a looping video player.
 @available(macOS 11.0, *)
 struct LoopPlayerViewRepresentableMacOS: NSViewRepresentable {
 
+    /// The settings for the video player.
     let settings: Settings
 
+    /// Creates the NSView instance for the video player.
+    /// - Parameter context: The context in which the view is created.
+    /// - Returns: An NSView that displays the video player, or an error view if there is an issue.
     func makeNSView(context: Context) -> NSView {
         let name = settings.name
         let ext = settings.ext
         let gravity = settings.gravity
         let color = settings.errorColor
         let fontSize = settings.errorFontSize
 
+        // Check if the settings are unique
         guard settings.areUnique else {
             return errorTplmacOS(.settingsNotUnique, color, fontSize)
         }
 
+        // Create the looping player view or return an error view if the file is not found
         guard let view = LoopingPlayerNSView(name, width: ext, gravity: gravity) else {
             return errorTplmacOS(.fileNotFound(name), color, fontSize)
         }
         return view
     }
 
+    /// Updates the NSView instance.
+    /// - Parameters:
+    ///   - nsView: The NSView instance to update.
+    ///   - context: The context in which the update occurs.
     func updateNSView(_ nsView: NSView, context: Context) {
+        // Update the view if necessary
     }
 }
 
 // MARK: - Helpers for macOS
 
+/// A custom NSTextView for displaying error messages on macOS.
 fileprivate class ErrorMsgTextViewMacOS: NSTextView {
 
+    /// Overrides the intrinsic content size to allow flexible width and height.
     override var intrinsicContentSize: NSSize {
         return NSSize(width: NSView.noIntrinsicMetric, height: NSView.noIntrinsicMetric)
     }
 
+    /// Called when the view is added to a superview. Sets up the constraints for the view.
     override func viewDidMoveToSuperview() {
         super.viewDidMoveToSuperview()
         guard let superview = superview else { return }
@@ -169,6 +184,7 @@ fileprivate class ErrorMsgTextViewMacOS: NSTextView {
         ])
     }
 
+    /// Adjusts the layout to center the text vertically within the view.
     override func layout() {
         super.layout()
 
@@ -184,6 +200,12 @@ fileprivate class ErrorMsgTextViewMacOS: NSTextView {
     }
 }
 
+/// Creates a custom error view for macOS displaying an error message.
+/// - Parameters:
+///   - error: The error object containing the error description.
+///   - color: The color to be used for the error text.
+///   - fontSize: The font size to be used for the error text.
+/// - Returns: An `NSView` containing the error message text view centered with padding.
 fileprivate func errorTplmacOS(_ error: VPErrors, _ color: Color, _ fontSize: CGFloat) -> NSView {
     let textView = ErrorMsgTextViewMacOS()
     textView.isEditable = false

Sources/swiftui-loop-videoplayer/enum/Setting.swift

@@ -6,8 +6,11 @@
 //
 
 import Foundation
-import AVKit
 import SwiftUI
+#if canImport(AVKit)
+import AVKit
+#endif
+
 
 /// Settings for loop video player
 @available(iOS 14.0, macOS 11.0, tvOS 14.0, *)

Sources/swiftui-loop-videoplayer/enum/VPErrors.swift

@@ -1,23 +1,31 @@
 //
-//  File.swift
-//  
+//  VPErrors.swift
+//
 //
 //  Created by Igor on 09.07.2023.
 //
 
 import Foundation
 
-enum VPErrors : Error, CustomStringConvertible{
+/// An enumeration of possible errors that can occur in the video player.
+enum VPErrors: Error, CustomStringConvertible {
 
+    /// Error case for when a file is not found.
+    /// - Parameter name: The name of the file that was not found.
     case fileNotFound(String)
 
+    /// Error case for when settings are not unique.
     case settingsNotUnique
 
-    var description: String{
-        switch(self){
-            case .fileNotFound(let name) : return "File not found \(name)"
-        case .settingsNotUnique : return "Settings are not unique"
+    /// A description of the error, suitable for display.
+    var description: String {
+        switch self {
+            /// Returns a description indicating that the specified file was not found.
+            /// - Parameter name: The name of the file that was not found.
+            case .fileNotFound(let name): return "File not found: \(name)"
 
+            /// Returns a description indicating that the settings are not unique.
+            case .settingsNotUnique: return "Settings are not unique"
         }
     }
 }

Sources/swiftui-loop-videoplayer/view/LoopingPlayerUIView.swift

@@ -5,10 +5,11 @@
 //  Created by Igor on 10.02.2023.
 //
 
+#if canImport(AVKit)
 import AVKit
+#endif
 
-
-#if canImport(UIKit) || os(tvOS)
+#if canImport(UIKit)
 import UIKit
 
 @available(iOS 14.0, tvOS 14.0, *)
@@ -30,7 +31,7 @@ class LoopingPlayerUIView: UIView {
     ///   - gravity: A structure that defines how a layer displays a player’s visual content within the layer’s bounds
     init?(_ name: String, width ext: String, gravity: AVLayerVideoGravity) {
 
-        /// Load the resource
+        // Load the resource
         guard let fileUrl = Bundle.main.url(forResource: name, withExtension: ext) else{
             return nil
         }
@@ -39,7 +40,7 @@ class LoopingPlayerUIView: UIView {
 
         let item = AVPlayerItem(asset: asset)
 
-        /// Setup the player
+        // Setup the player
         let player = AVQueuePlayer()
         player.isMuted = true
         playerLayer.player = player
@@ -48,10 +49,10 @@ class LoopingPlayerUIView: UIView {
 
         super.init(frame: CGRect.zero)
 
-        /// Create a new player looper with the queue player and template item
+        // Create a new player looper with the queue player and template item
         playerLooper = AVPlayerLooper(player: player, templateItem: item)
 
-        /// Start the movie
+        // Start the movie
         player.play()
 
         layer.addSublayer(playerLayer)
@@ -63,7 +64,6 @@ class LoopingPlayerUIView: UIView {
         playerLayer.frame = bounds
     }
 }
-
 #elseif canImport(Cocoa)
 import Cocoa
 
@@ -86,7 +86,7 @@ class LoopingPlayerNSView: NSView {
     ///   - gravity: A structure that defines how a layer displays a player’s visual content within the layer’s bounds
     init?(_ name: String, width ext: String, gravity: AVLayerVideoGravity) {
 
-        /// Load the resource
+        // Load the resource
         guard let fileUrl = Bundle.main.url(forResource: name, withExtension: ext) else{
             return nil
         }
@@ -95,7 +95,7 @@ class LoopingPlayerNSView: NSView {
 
         let item = AVPlayerItem(asset: asset)
 
-        /// Setup the player
+        // Setup the player
         let player = AVQueuePlayer()
         player.isMuted = true
         playerLayer.player = player
@@ -104,18 +104,18 @@ class LoopingPlayerNSView: NSView {
 
         super.init(frame: .zero)
 
-        /// Create a new player looper with the queue player and template item
+        // Create a new player looper with the queue player and template item
         playerLooper = AVPlayerLooper(player: player, templateItem: item)
 
-        /// Start the movie
+        // Start the movie
         player.play()
 
         layer = CALayer()
         layer?.addSublayer(playerLayer)
         wantsLayer = true
     }
 
-    /// Called automatically when the view's bounds change
+    // Called automatically when the view's bounds change
     override func layout() {
         super.layout()
         playerLayer.frame = bounds