Add documentation for public methods and properties.

Author: anton-barkov

Sources/SpringMotionLayer.swift

@@ -20,7 +20,6 @@ open class SpringMotionLayer: CALayer {
     /// Moves the layer to the specified point with spring animation.
     ///
     /// - Parameter point: a `CGPoint` that defines the layer's destination and represents the layer's center point.
-    /// - Parameter callback: a closure to call when spring motion has stopped.
     public func move(to point: CGPoint) {
         motionStates = motionPhysics.calculateAllStates(
             from: getCurrentMotionState(),

Sources/SpringMotionView-iOS.swift

@@ -11,14 +11,21 @@ import UIKit
 
 open class SpringMotionView: UIView {
 
-    public var onPositionUpdate: ((CGPoint) -> Void)?
-
+    /// Configuration that adjusts the spring physics behind the animation.
     public var configuration: SpringConfiguration = .default {
         didSet {
             motionPhysics = .init(configuration: configuration, timeStep: timeStep)
         }
     }
 
+    /// A closure that is called on every step of animation.
+    /// Within it you should update any relevant constraints to position the view according
+    /// to the `CGPoint` parameter passed into the closure. This point represents the center of the view.
+    public var onPositionUpdate: ((CGPoint) -> Void)?
+    
+    /// Moves the view to the specified point with spring animation.
+    ///
+    /// - Parameter point: a `CGPoint` that defines the view's destination and represents the view's center point.
     public func move(to point: CGPoint) {
         destinationPoint = point
     }

Sources/SpringMotionView-macOS.swift

@@ -11,14 +11,21 @@ import AppKit
 
 open class SpringMotionView: NSView {
 
-    public var onPositionUpdate: ((NSPoint) -> Void)?
-
+    /// Configuration that adjusts the spring physics behind the animation.
     public var configuration: SpringConfiguration = .default {
         didSet {
             motionPhysics = .init(configuration: configuration, timeStep: timeStep)
         }
     }
 
+    /// A closure that is called on every step of animation.
+    /// Within it you should update any relevant constraints to position the view according
+    /// to the `CGPoint` parameter passed into the closure. This point represents the center of the view.
+    public var onPositionUpdate: ((NSPoint) -> Void)?
+    
+    /// Moves the view to the specified point with spring animation.
+    ///
+    /// - Parameter point: a `CGPoint` that defines the view's destination and represents the view's center point.
     public func move(to point: NSPoint) {
         destinationPoint = point
     }

Sources/SpringMotionWindow.swift

@@ -11,6 +11,7 @@ import AppKit
 
 open class SpringMotionWindow: NSWindow {
 
+    /// Configuration that adjusts the spring physics behind the animation.
     public var configuration: SpringConfiguration = .default {
         didSet {
             motionPhysics = .init(configuration: configuration, timeStep: 0.008)
@@ -33,12 +34,17 @@ open class SpringMotionWindow: NSWindow {
 // MARK: - API
 public extension SpringMotionWindow {
 
+    /// Moves the window to the specified point with spring animation.
+    ///
+    /// - Parameter point: a `CGPoint` that defines the window's destination and represents the window's center point.
     func move(to point: NSPoint) {
         destinationPoint = point
     }
 
-    /// Starts following the given window.
-    /// `offsetFromCenter` is the difference between this window's center and the anchor window's center.
+    /// Starts following the given window with a certain offset from its center.
+    ///
+    /// - Parameter anchorWindow: an `NSWindow` that this window will follow.
+    /// - Parameter offsetFromCenter: the difference between this window's center and the anchor window's center.
     func pinToWindow(_ anchorWindow: NSWindow, offsetFromCenter: NSPoint) {
         unpinFromWindow()
         move(to: anchorWindow.frame.center + offsetFromCenter)