added comments

Author: swiftuiux

Sources/swiftui-loop-videoplayer/ExtVideoPlayer.swift

@@ -102,6 +102,7 @@ public struct ExtVideoPlayer: View{
 
     // MARK: - API
 
+   /// The body property defines the view hierarchy for the user interface.
    public var body: some View {
 
        LoopPlayerMultiPlatform(

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

@@ -14,6 +14,7 @@ import CoreImage
 @available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
 public enum PlaybackCommand: Equatable {
 
+    /// The idle command to do nothing
     case idle
 
     /// Command to play the video.

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

@@ -15,6 +15,8 @@ import AVKit
 @available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
 public enum Setting: Equatable, SettingsConvertible{
 
+    /// Converts the current setting to an array containing only this setting.
+    /// - Returns: An array of `Setting` containing the single instance of this setting.
     public func asSettings() -> [Setting] {
         [self]
     }

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

@@ -44,6 +44,12 @@ public enum VPErrors: Error, CustomStringConvertible, Sendable{
 
 @available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
 extension VPErrors: Equatable {
+    
+    /// Compares two `VPErrors` instances for equality based on specific error conditions.
+    /// - Parameters:
+    ///   - lhs: The left-hand side `VPErrors` instance to compare.
+    ///   - rhs: The right-hand side `VPErrors` instance to compare.
+    /// - Returns: A Boolean value indicating whether the two `VPErrors` instances are considered equal.
     public static func ==(lhs: VPErrors, rhs: VPErrors) -> Bool {
         switch (lhs, rhs) {
         case (.remoteVideoError(let a), .remoteVideoError(let b)):

Sources/swiftui-loop-videoplayer/ext+/CMTime+.swift

@@ -9,7 +9,11 @@
 import AVKit
 #endif
 
-extension CMTime : SettingsConvertible{
+/// Extends `CMTime` to conform to the `SettingsConvertible` protocol.
+extension CMTime : SettingsConvertible {
+    
+    /// Converts the `CMTime` instance into a settings array containing a time publishing setting.
+    /// - Returns: An array of `Setting` with the `timePublishing` case initialized with this `CMTime` instance.
     public func asSettings() -> [Setting] {
         [.timePublishing(self)]
     }

Sources/swiftui-loop-videoplayer/ext+/URL+.swift

@@ -7,12 +7,14 @@
 
 import Foundation
 
-/// Validates a string as a well-formed HTTP or HTTPS URL and returns a URL object if valid.
-///
-/// - Parameter urlString: The string to validate as a URL.
-/// - Returns: An optional URL object if the string is a valid URL.
-/// - Throws: An error if the URL is not valid or cannot be created.
+
 extension URL {
+    
+    /// Validates a string as a well-formed HTTP or HTTPS URL and returns a URL object if valid.
+    ///
+    /// - Parameter urlString: The string to validate as a URL.
+    /// - Returns: An optional URL object if the string is a valid URL.
+    /// - Throws: An error if the URL is not valid or cannot be created.
     static func validURLFromString(_ string: String) -> URL? {
         let pattern = "^(https?:\\/\\/)(([a-zA-Z0-9-]+\\.)*[a-zA-Z0-9-]+\\.[a-zA-Z]{2,})(:\\d{1,5})?(\\/[\\S]*)?$"
         let regex = try? NSRegularExpression(pattern: pattern, options: [])

Sources/swiftui-loop-videoplayer/protocol/helpers/SettingsConvertible.swift

@@ -7,8 +7,9 @@
 
 import Foundation
 
-@available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
+
 /// Protocol for building blocks
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
 public protocol SettingsConvertible {
 
     /// Fetch settings

Sources/swiftui-loop-videoplayer/protocol/player/AbstractPlayer.swift

@@ -10,6 +10,8 @@ import AVFoundation
 import CoreImage
 #endif
 
+/// Defines an abstract player protocol to be implemented by player objects, ensuring main-thread safety and compatibility with specific OS versions.
+/// This protocol is designed for use with classes (reference types) only.
 @available(iOS 14, macOS 11, tvOS 14, *)
 @MainActor @preconcurrency
 public protocol AbstractPlayer: AnyObject {

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

@@ -21,13 +21,16 @@ import AppKit
 public protocol LoopingPlayerProtocol: AbstractPlayer, LayerMakerProtocol{
 
     #if canImport(UIKit)
-        var layer : CALayer { get }
+        /// Provides a non-optional `CALayer` for use within UIKit environments.
+        var layer: CALayer { get }
     #elseif canImport(AppKit)
-        var layer : CALayer? { get set }
-        var wantsLayer : Bool { get set }
+        /// Provides an optional `CALayer` which can be set, and a property to indicate if the layer is wanted, for use within AppKit environments.
+        var layer: CALayer? { get set }
+        var wantsLayer: Bool { get set }
     #endif
-    
-    var playerLayer : AVPlayerLayer { get }
+
+    /// Provides a `AVPlayerLayer` specific to the player implementation, applicable across all platforms.
+    var playerLayer: AVPlayerLayer { get }
 
     /// An optional NSKeyValueObservation to monitor errors encountered by the video player.
     /// This observer should be configured to detect and handle errors from the AVQueuePlayer,

Sources/swiftui-loop-videoplayer/protocol/vector/ShapeLayerBuilderProtocol.swift

@@ -18,6 +18,7 @@ import QuartzCore
 @available(iOS 14, macOS 11, tvOS 14, *)
 public protocol ShapeLayerBuilderProtocol: Identifiable {
 
+    /// Unique identifier
     var id : UUID { get }
 
     /// Builds a CAShapeLayer using specified geometry.