Update documentation

Author: stleamist

README.md

@@ -1367,17 +1367,17 @@ The property expose the `UIKit` value [`UIView.keyboardLayoutGuide`](https://dev
 <a name="wrapContent"></a>
 ## WrapContent
 
-The following methods are useful to adjust view's width and/or height to wrap all its subviews. These methods also adjust subviews position to create a tight wrap.
+The following methods are useful to adjust view's width and/or height to wrap all its subviews that are included in the layout. These methods also adjust subviews position to create a tight wrap.
 
 **Methods:**
 
 * **`wrapContent()`**  
 **`wrapContent(padding: CGFloat)`**  
 **`wrapContent(padding: UIEdgeInsets)`**   
-Adjust the view's width and height to wrap all its subviews. The method also adjusts subviews's position to create a tight wrap. It is also possible to specify an optional padding around all subviews. 
+Adjust the view's width and height to wrap all its subviews that are included in the layout. The method also adjusts subviews's position to create a tight wrap. It is also possible to specify an optional padding around all subviews. 
 * **`wrapContent(:WrapType)`**  
 **`wrapContent(:WrapType, padding: CGFloat)`**  **`wrapContent(:WrapType, padding: UIEdgeInsets)`**  
-Adjust the view's width AND/OR height to wrap all its subviews. Accept a WrapType parameter to define the wrapping type. It is also possible to specify an optional padding around all subviews.
+Adjust the view's width AND/OR height to wrap all its subviews that are included in the layout. Accept a WrapType parameter to define the wrapping type. It is also possible to specify an optional padding around all subviews.
 
 **Types:** 
 

Sources/Layoutable.swift

@@ -29,6 +29,11 @@ public protocol Layoutable: AnyObject, Equatable, CustomDebugStringConvertible {
     var superview: PinView? { get }
     var subviews: [PinView] { get }
 
+    /// A Boolean value that determines whether the view is included in the PinLayout's layout.
+    ///
+    /// An excluded view does not take up space in the layout
+    /// when using `wrapContent(_:padding:_:)` or `autoSizeThatFits(_:layoutClosure:)`.
+    /// The default value is `true`.
     var isIncludedInPinLayout: Bool { get set }
 
     func getRect(keepTransform: Bool) -> CGRect

Sources/PinLayout+WrapContent.swift

@@ -25,15 +25,15 @@ import AppKit
 
 extension PinLayout {
     /**
-     Adjust the view's width & height to wrap all its subviews. The method also adjust subviews position to create a tight wrap.
+     Adjust the view's width & height to wrap all its subviews that are included in the layout. The method also adjust subviews position to create a tight wrap.
      */
     @discardableResult
     public func wrapContent() -> PinLayout {
         return wrapContent(.all, padding: PEdgeInsets(top: 0, left: 0, bottom: 0, right: 0), { return "wrapContent()" })
     }
 
     /**
-     Adjust the view's width & height to wrap all its subviews. The method also adds a padding around all subviews.
+     Adjust the view's width & height to wrap all its subviews that are included in the layout. The method also adds a padding around all subviews.
 
      - Parameters:
      - padding: Specify a padding value.
@@ -45,7 +45,7 @@ extension PinLayout {
 
     /**
      The method...
-        - Adjust the view's width and height to wrap all its subviews.
+        - Adjust the view's width and height to wrap all its subviews that are included in the layout.
         - Adjust subviews's position to create a tight wrap.
         - Apply padding around all subviews.
 
@@ -59,7 +59,7 @@ extension PinLayout {
 
     /**
      The method...
-     - Adjust the view's width and height to wrap all its subviews.
+     - Adjust the view's width and height to wrap all its subviews that are included in the layout.
      - Adjust subviews's position to create a tight wrap.
 
      - Parameters:
@@ -72,7 +72,7 @@ extension PinLayout {
 
     /**
      The method...
-     - Adjust the view's width and height to wrap all its subviews.
+     - Adjust the view's width and height to wrap all its subviews that are included in the layout.
      - Adjust subviews's position to create a tight wrap.
      - Apply padding around all subviews.
 
@@ -87,7 +87,7 @@ extension PinLayout {
 
     /**
      The method...
-     - Adjust the view's width and height to wrap all its subviews.
+     - Adjust the view's width and height to wrap all its subviews that are included in the layout.
      - Adjust subviews's position to create a tight wrap.
      - Apply padding around all subviews.
 

Sources/Types.swift

@@ -186,11 +186,11 @@ public enum FitType {
 }
 
 @objc public enum WrapType: Int {
-    /// Adjust the view's width AND height to wrap all its subviews.
+    /// Adjust the view's width AND height to wrap all its subviews that are included in the layout.
     case all
-    /// Adjust only the view's width to wrap all its subviews. The view's height won't be modified.
+    /// Adjust only the view's width to wrap all its subviews that are included in the layout. The view's height won't be modified.
     case horizontally
-    /// Adjust only the view's height to wrap all its subviews. The view's width won't be modified.
+    /// Adjust only the view's height to wrap all its subviews that are included in the layout. The view's width won't be modified.
     case vertically
 }