add docs for config types

Author: mikhailChelbaev

Sources/ComponentsKit/Configuration/Config.swift

@@ -1,14 +1,24 @@
 import Foundation
 
+/// A configuration structure for customizing colors and layout attributes of the components.
 public struct ComponentsKitConfig: Initializable, Updatable {
+  // MARK: - Properties
+
+  /// The palette of colors.
   public var colors: Palette = .init()
+
+  /// The layout configuration.
   public var layout: Layout = .init()
 
+  // MARK: - Initialization
+
+  /// Initializes a new `ComponentsKitConfig` instance with default values.
   public init() {}
 }
 
 // MARK: - ComponentsKitConfig + Shared
 
 extension ComponentsKitConfig {
+  /// A shared instance of `ComponentsKitConfig` for global use.
   public static var shared: Self = .init()
 }

Sources/ComponentsKit/Configuration/Layout.swift

@@ -1,41 +1,75 @@
 import Foundation
 
+/// A structure that defines the layout-related configurations for components in the framework.
 public struct Layout: Initializable, Updatable {
-  // MARK: Radius
+  // MARK: - Radius
 
+  /// A structure representing radius values for components.
   public struct Radius {
+    /// The small radius size.
     public var small: CGFloat
+    /// The medium radius size.
     public var medium: CGFloat
+    /// The large radius size.
     public var large: CGFloat
 
+    /// Initializes a new `Radius` instance.
+    ///
+    /// - Parameters:
+    ///   - small: The small radius size.
+    ///   - medium: The medium radius size.
+    ///   - large: The large radius size.
     public init(small: CGFloat, medium: CGFloat, large: CGFloat) {
       self.small = small
       self.medium = medium
       self.large = large
     }
   }
 
-  // MARK: BorderWidth
+  // MARK: - BorderWidth
 
+  /// A structure representing border width values for components.
   public struct BorderWidth {
+    /// The small border width.
     public var small: CGFloat
+    /// The medium border width.
     public var medium: CGFloat
+    /// The large border width.
     public var large: CGFloat
 
+    /// Initializes a new `BorderWidth` instance.
+    ///
+    /// - Parameters:
+    ///   - small: The small border width.
+    ///   - medium: The medium border width.
+    ///   - large: The large border width.
     public init(small: CGFloat, medium: CGFloat, large: CGFloat) {
       self.small = small
       self.medium = medium
       self.large = large
     }
   }
 
-  // MARK: AnimationScale
+  // MARK: - AnimationScale
 
+  /// A structure representing animation scale values for components.
+  ///
+  /// The values must be between `0.0` and `1.0`.
   public struct AnimationScale {
+    /// The small animation scale.
     public var small: CGFloat
+    /// The medium animation scale.
     public var medium: CGFloat
+    /// The large animation scale.
     public var large: CGFloat
 
+    /// Initializes a new `AnimationScale` instance.
+    ///
+    /// - Parameters:
+    ///   - small: The small animation scale (0.0–1.0).
+    ///   - medium: The medium animation scale (0.0–1.0).
+    ///   - large: The large animation scale (0.0–1.0).
+    /// - Warning: This initializer will crash if the values are outside the range of `0.0` to `1.0`.
     public init(small: CGFloat, medium: CGFloat, large: CGFloat) {
       guard small >= 0 && small <= 1.0,
             medium >= 0 && medium <= 1.0,
@@ -50,26 +84,48 @@ public struct Layout: Initializable, Updatable {
     }
   }
 
-  // MARK: Fonts
+  // MARK: - Typography
 
+  /// A structure representing a set of fonts for different component sizes.
   public struct FontSet {
+    /// The small font.
     public var small: UniversalFont
+    /// The medium font.
     public var medium: UniversalFont
+    /// The large font.
     public var large: UniversalFont
 
+    /// Initializes a new `FontSet` instance.
+    ///
+    /// - Parameters:
+    ///   - small: The small font.
+    ///   - medium: The medium font.
+    ///   - large: The large font.
     public init(small: UniversalFont, medium: UniversalFont, large: UniversalFont) {
       self.small = small
       self.medium = medium
       self.large = large
     }
   }
 
+  /// A structure representing typography settings for various components.
   public struct Typography {
+    /// The font set for headlines.
     public var headline: FontSet
+    /// The font set for body text.
     public var body: FontSet
+    /// The font set for buttons.
     public var button: FontSet
+    /// The font set for captions.
     public var caption: FontSet
 
+    /// Initializes a new `Typography` instance.
+    ///
+    /// - Parameters:
+    ///   - headline: The font set for headlines.
+    ///   - body: The font set for body text.
+    ///   - button: The font set for buttons.
+    ///   - caption: The font set for captions.
     public init(headline: FontSet, body: FontSet, button: FontSet, caption: FontSet) {
       self.headline = headline
       self.body = body
@@ -78,24 +134,33 @@ public struct Layout: Initializable, Updatable {
     }
   }
 
-  // MARK: Properties
+  // MARK: - Properties
 
+  /// The opacity level for disabled components.
   public var disabledOpacity: CGFloat = 0.5
+
+  /// The radius configuration for components.
   public var componentRadius: Radius = .init(
     small: 10.0,
     medium: 12.0,
     large: 16.0
   )
+
+  /// The border width configuration for components.
   public var borderWidth: BorderWidth = .init(
     small: 1.0,
     medium: 2.0,
     large: 3.0
   )
+
+  /// The animation scale configuration for components.
   public var animationScale: AnimationScale = .init(
     small: 0.99,
     medium: 0.98,
     large: 0.95
   )
+
+  /// The typography configuration for components.
   public var typography: Typography = .init(
     headline: .init(
       small: .system(size: 14, weight: .semibold),
@@ -119,5 +184,8 @@ public struct Layout: Initializable, Updatable {
     )
   )
 
+  // MARK: - Initialization
+
+  /// Initializes a new `Layout` instance with default values.
   public init() {}
 }