add docs for shared types

Author: mikhailChelbaev

Examples/DemosApp/DemosApp/ComponentsPreview/PreviewPages/ButtonPreview.swift

@@ -32,7 +32,6 @@ struct ButtonPreview: View {
           Text("Bordered with small border").tag(ButtonVM.Style.bordered(.small))
           Text("Bordered with medium border").tag(ButtonVM.Style.bordered(.medium))
           Text("Bordered with large border").tag(ButtonVM.Style.bordered(.large))
-          Text("Bordered with custom border: 6px").tag(ButtonVM.Style.bordered(.custom(6)))
         }
       }
     }

Sources/ComponentsKit/Shared/Types/AnimationScale.swift

@@ -1,30 +1,46 @@
 import Foundation
 
-public struct AnimationScale: Hashable {
-  var value: CGFloat
-
-  init(_ value: CGFloat) {
-    self.value = value
-  }
+/// An enumeration that defines how much a component shrinks or expands during animations.
+public enum AnimationScale: Hashable {
+  /// No scaling is applied, meaning the component remains at its original size.
+  case none
+  /// A small scaling effect is applied, using a predefined value from the configuration.
+  case small
+  /// A medium scaling effect is applied, using a predefined value from the configuration.
+  case medium
+  /// A large scaling effect is applied, using a predefined value from the configuration.
+  case large
+  /// A custom scaling value.
+  ///
+  /// - Parameter value: The custom scale value (0.0–1.0).
+  case custom(_ value: CGFloat)
 }
 
 extension AnimationScale {
-  public static var none: Self {
-    return Self(1.0)
-  }
-  public static var small: Self {
-    return Self(ComponentsKitConfig.shared.layout.animationScale.small)
-  }
-  public static var medium: Self {
-    return Self(ComponentsKitConfig.shared.layout.animationScale.medium)
-  }
-  public static var large: Self {
-    return Self(ComponentsKitConfig.shared.layout.animationScale.large)
-  }
-  public static func custom(_ value: CGFloat) -> Self {
-    guard value >= 0 && value <= 1.0 else {
-      fatalError("Animation scale value should be between 0 and 1")
+  /// The scaling value represented as a `CGFloat`.
+  ///
+  /// - Returns:
+  ///   - `1.0` for `.none` (no scaling).
+  ///   - Predefined values from `ComponentsKitConfig` for `.small`, `.medium`, and `.large`.
+  ///   - The custom value provided for `.custom`, constrained between `0.0` and `1.0`.
+  /// - Note: If the custom value is outside the range `0.0–1.0`, an assertion failure occurs,
+  ///   and a default value of `1.0` is returned.
+  public var value: CGFloat {
+    switch self {
+    case .none:
+      return 1.0
+    case .small:
+      return ComponentsKitConfig.shared.layout.animationScale.small
+    case .medium:
+      return ComponentsKitConfig.shared.layout.animationScale.medium
+    case .large:
+      return ComponentsKitConfig.shared.layout.animationScale.large
+    case .custom(let value):
+      guard value >= 0 && value <= 1.0 else {
+        assertionFailure("Animation scale value should be between 0 and 1")
+        return 1.0
+      }
+      return value
     }
-    return Self(value)
   }
 }

Sources/ComponentsKit/Shared/Types/BorderWidth.swift

@@ -1,24 +1,25 @@
 import Foundation
 
-public struct BorderWidth: Hashable {
-  var value: CGFloat
-
-  init(_ value: CGFloat) {
-    self.value = value
-  }
+/// An enumeration that defines border thickness for components.
+public enum BorderWidth: Hashable {
+  /// A small border width.
+  case small
+  /// A medium border width.
+  case medium
+  /// A large border width.
+  case large
 }
 
 extension BorderWidth {
-  public static var small: Self {
-    return Self(ComponentsKitConfig.shared.layout.borderWidth.small)
-  }
-  public static var medium: Self {
-    return Self(ComponentsKitConfig.shared.layout.borderWidth.medium)
-  }
-  public static var large: Self {
-    return Self(ComponentsKitConfig.shared.layout.borderWidth.large)
-  }
-  public static func custom(_ value: CGFloat) -> Self {
-    return Self(value)
+  /// The numeric value of the border width as a `CGFloat`.
+  public var value: CGFloat {
+    switch self {
+    case .small:
+      return ComponentsKitConfig.shared.layout.borderWidth.small
+    case .medium:
+      return ComponentsKitConfig.shared.layout.borderWidth.medium
+    case .large:
+      return ComponentsKitConfig.shared.layout.borderWidth.large
+    }
   }
 }

Sources/ComponentsKit/Shared/Types/ComponentRadius.swift

@@ -1,16 +1,29 @@
 import Foundation
 import SwiftUI
 
+/// An enumeration that defines the corner radius options for components.
 public enum ComponentRadius: Hashable {
+  /// No corner radius, resulting in sharp edges.
   case none
+  /// A small corner radius.
   case small
+  /// A medium corner radius.
   case medium
+  /// A large corner radius.
   case large
+  /// A fully rounded corner radius, where the radius is half of the component's height.
   case full
+  /// A custom corner radius with a specific value.
+  ///
+  /// - Parameter value: The radius value as a `CGFloat`.
   case custom(CGFloat)
 }
 
 extension ComponentRadius {
+  /// Returns the numeric value of the corner radius, ensuring it does not exceed half the component's height.
+  ///
+  /// - Parameter height: The height of the component. Defaults to a large number (10,000) for unrestricted calculations.
+  /// - Returns: The calculated corner radius as a `CGFloat`, capped at half of the height for `full` rounding or custom values.
   func value(for height: CGFloat = 10_000) -> CGFloat {
     let maxValue = height / 2
     let value = switch self {