added comments

Author: swiftuiux

Sources/swiftui-loop-videoplayer/protocol/view/LoopingPlayerProtocol.swift

@@ -169,14 +169,24 @@ extension LoopingPlayerProtocol {
         }
     }
 
+    /// Removes the observers associated with the current AVPlayerItem.
+    ///
+    /// This function invalidates the status observer and removes the notification observer for the AVPlayerItem's end time event.
     func removeItemObservers(){
+        // Invalidate and remove the status observer.
         statusObserver?.invalidate()
         statusObserver = nil
 
+        // Remove the observer for the AVPlayerItemDidPlayToEndTime notification.
         NotificationCenter.default.removeObserver(self, name: .AVPlayerItemDidPlayToEndTime, object: nil)
     }
-    
+
+    /// Adds observers to the specified AVPlayerItem.
+    ///
+    /// This function observes changes to the status of the AVPlayerItem and registers a handler for status changes.
+    /// - Parameter item: The AVPlayerItem to observe.
     func addItemObservers(for item: AVPlayerItem){
+        // Observe the status property of the AVPlayerItem and handle changes using the provided closure.
         statusObserver = item.observe(\.status, options: [.new, .old]) { [weak self] item, _ in
             self?.handlePlayerItemStatusChange(item)
             print(item)
@@ -266,5 +276,4 @@ extension LoopingPlayerProtocol {
             removeAllVectors()
         }
     }
-
 }

Sources/swiftui-loop-videoplayer/protocol/view/VectorLayerProtocol.swift

@@ -12,36 +12,57 @@ import AppKit
 #endif
 import QuartzCore
 
+/// A protocol that defines methods and properties for managing vector layers within a composite layer.
+///
+/// This protocol is intended to be used for managing the addition and removal of vector layers,
+/// which are overlaid on top of other content, such as video streams.
+///
 @available(iOS 14, macOS 11, tvOS 14, *)
 @MainActor
-public protocol LayerMakerProtocol{
-    
-    var compositeLayer : CALayer{ get }
-    
+public protocol LayerMakerProtocol {
+
+    /// The composite layer that contains all the sublayers, including vector layers.
+    ///
+    /// This layer acts as a container for all vector layers added through the protocol methods.
+    var compositeLayer: CALayer { get }
+
+    /// The frame of the composite layer.
+    ///
+    /// This property defines the size and position of the composite layer within its parent view.
     var frame: CGRect { get set }
-    
-    var bounds : CGRect { get set }
-    
-    func addVectorLayer(builder : any ShapeLayerBuilderProtocol, clear: Bool)
-    
+
+    /// The bounds of the composite layer.
+    ///
+    /// This property defines the drawable area of the composite layer, relative to its own coordinate system.
+    var bounds: CGRect { get set }
+
+    /// Adds a vector layer to the composite layer using a specified builder.
+    ///
+    /// - Parameters:
+    ///   - builder: An instance conforming to `ShapeLayerBuilderProtocol` that constructs the vector layer.
+    ///   - clear: A Boolean value that indicates whether to clear existing vector layers before adding the new one.
+    func addVectorLayer(builder: any ShapeLayerBuilderProtocol, clear: Bool)
+
+    /// Removes all vector layers from the composite layer.
     func removeAllVectors()
 }
 
 extension LayerMakerProtocol{
 
     @MainActor
-    /// Sets a vector graphic operation on the video player.
+    /// Adds a vector layer to the composite layer using a specified builder.
+    ///
     /// - Parameters:
-    ///   - builder: An instance conforming to `ShapeLayerBuilderProtocol` to provide the shape layer.
-    ///   - clear: A Boolean value indicating whether to clear existing vector graphics before applying the new one. Defaults to `false`.
+    ///   - builder: An instance conforming to `ShapeLayerBuilderProtocol` that constructs the vector layer.
+    ///   - clear: A Boolean value that indicates whether to clear existing vector layers before adding the new one.
     func addVectorLayer(builder : any ShapeLayerBuilderProtocol, clear: Bool){
         if clear{ removeAllVectors() }
         let layer = builder.build(with: (frame, bounds))
         compositeLayer.addSublayer(layer)
     }
 
     @MainActor
-    /// Clears all vector graphics from the video player.
+    /// Removes all vector layers from the composite layer.
     func removeAllVectors(){
             compositeLayer.sublayers?.forEach { $0.removeFromSuperlayer() }
     }