Add documentation for SketchKitLayoutGuideDSL and SketchKitViewDSL

dogo · Oct 21, 2020 · e19ec8d · e19ec8d
1 parent a51e9cb
commit e19ec8d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Sources/SketchKit/SketchKitLayoutGuideDSL.swift b/Sources/SketchKit/SketchKitLayoutGuideDSL.swift
@@ -9,11 +9,13 @@ import UIKit
 
 public extension UILayoutGuide {
 
+    /// Property to access the SketchKitLayoutGuideDSL and be able to applyConstraints
     var layout: SketchKitLayoutGuideDSL {
         return SketchKitLayoutGuideDSL(layoutGuide: self)
     }
 }
 
+/// SketchKitLayoutGuideDSL
 public class SketchKitLayoutGuideDSL {
 
     let layoutGuide: UILayoutGuide
@@ -22,6 +24,8 @@ public class SketchKitLayoutGuideDSL {
         self.layoutGuide = layoutGuide
     }
 
+    /// Apply all the constraints to a UILayoutGuide using SketchKitLayoutGuideDSL
+    /// - Parameter block: Block with all constraints to be applied to the current layoutGuide.
     public func applyConstraint(_ block: ((UILayoutGuide) -> Void)) {
         block(self.layoutGuide)
     }

diff --git a/Sources/SketchKit/SketchKitViewDSL.swift b/Sources/SketchKit/SketchKitViewDSL.swift
@@ -10,11 +10,13 @@ import UIKit
 
 public extension UIView {
 
+    /// Property to access the SketchKitViewDSL and be able to applyConstraints
     var layout: SketchKitViewDSL {
         return SketchKitViewDSL(view: self)
     }
 }
 
+/// SketchKitViewDSL
 public class SketchKitViewDSL {
 
     let view: UIView
@@ -23,6 +25,8 @@ public class SketchKitViewDSL {
         self.view = view
     }
 
+    /// Apply all the constraints to a UIView using SketchKitLayoutGuideDSL
+    /// - Parameter block: Block with all constraints to be applied to the current layoutGuide.
     public func applyConstraint(_ block: ((UIView) -> Void)) {
         self.view.translatesAutoresizingMaskIntoConstraints = false
         block(self.view)