doc: add docs

Author: omaralbeik

.gitignore

@@ -41,9 +41,6 @@ Pods/
 ## Carthage
 Carthage/Build
 
-## Jazzy docs
-docs/
-
 ## Fastlane
 fastlane/report.xml
 fastlane/Preview.html

Docs/Drop.md

@@ -0,0 +1,83 @@
+# Drop
+
+An object representing a drop.
+
+``` swift
+public struct Drop 
+```
+
+## Initializers
+
+### `init(title:subtitle:icon:action:style:duration:)`
+
+Create a new drop.
+
+``` swift
+public init(
+        title: String,
+        subtitle: String? = nil,
+        icon: UIImage? = nil,
+        action: Action? = nil,
+        style: Style = .top,
+        duration: Duration = .recommended
+    ) 
+```
+
+#### Parameters
+
+  - title: Title.
+  - subtitle: Optional subtitle. Defaults to `nil`.
+  - icon: Optional icon.
+  - action: Optional action.
+  - style: Style. Defaults to `Drop.Style.top`.
+  - duration: Duration. Defaults to `Drop.Duration.recommended`.
+
+## Properties
+
+### `title`
+
+Title.
+
+``` swift
+public var title: String
+```
+
+### `subtitle`
+
+Subtitle.
+
+``` swift
+public var subtitle: String?
+```
+
+### `icon`
+
+Icon.
+
+``` swift
+public var icon: UIImage?
+```
+
+### `action`
+
+Action.
+
+``` swift
+public var action: Action?
+```
+
+### `style`
+
+Style.
+
+``` swift
+public var style: Style
+```
+
+### `duration`
+
+Duration.
+
+``` swift
+public var duration: Duration
+```

Docs/Drop_Action.md

@@ -0,0 +1,40 @@
+# Drop.Action
+
+An object representing a drop action.
+
+``` swift
+public struct Action 
+```
+
+## Initializers
+
+### `init(icon:handler:)`
+
+Create a new action.
+
+``` swift
+public init(icon: UIImage? = nil, handler: @escaping () -> Void) 
+```
+
+#### Parameters
+
+  - icon: Optional icon image.
+  - handler: Handler to be called when the drop is tapped.
+
+## Properties
+
+### `icon`
+
+Icon.
+
+``` swift
+public var icon: UIImage?
+```
+
+### `handler`
+
+Handler.
+
+``` swift
+public var handler: () -> Void
+```

Docs/Drop_Duration.md

@@ -0,0 +1,25 @@
+# Drop.Duration
+
+An enum representing a drop duration on screen.
+
+``` swift
+public enum Duration 
+```
+
+## Enumeration Cases
+
+### `recommended`
+
+Hides the drop after 2.0 seconds.
+
+``` swift
+case recommended
+```
+
+### `seconds`
+
+Hides the drop after the specified number of seconds.
+
+``` swift
+case seconds(TimeInterval)
+```

Docs/Drop_Style.md

@@ -0,0 +1,25 @@
+# Drop.Style
+
+An enum representing drop presentation style.
+
+``` swift
+public enum Style 
+```
+
+## Enumeration Cases
+
+### `top`
+
+Drop is presented from top.
+
+``` swift
+case top
+```
+
+### `bottom`
+
+Drop is presented from bottom.
+
+``` swift
+case bottom
+```

Docs/Drops.md

@@ -0,0 +1,41 @@
+# Drops
+
+Drops.
+
+``` swift
+public final class Drops 
+```
+
+## Inheritance
+
+[`AnimatorDelegate`](/AnimatorDelegate)
+
+## Methods
+
+### `show(_:)`
+
+Show a drop.
+
+``` swift
+static func show(_ drop: Drop) 
+```
+
+#### Parameters
+
+  - drop: `Drop` to show.
+
+### `hideAll()`
+
+Hide all drops.
+
+``` swift
+static func hideAll() 
+```
+
+### `hideCurrent()`
+
+Hide currently shown drop.
+
+``` swift
+static func hideCurrent() 
+```

Docs/Home.md

@@ -0,0 +1,12 @@
+# Types
+
+  - [Drops](/Drops):
+    Drops.
+  - [Drop.Style](/Drop_Style):
+    An enum representing drop presentation style.
+  - [Drop.Duration](/Drop_Duration):
+    An enum representing a drop duration on screen.
+  - [Drop](/Drop):
+    An object representing a drop.
+  - [Drop.Action](/Drop_Action):
+    An object representing a drop action.

Docs/_Footer.md

@@ -0,0 +1 @@
+Generated at 2021-05-05T04:34:09+0200 using [swift-doc](https://github.com/SwiftDocOrg/swift-doc) 1.0.0-beta.6.

Docs/_Sidebar.md

@@ -0,0 +1,10 @@
+<details>
+<summary>Types</summary>
+
+  - [Drop](/Drop)
+  - [Drop.Action](/Drop.Action)
+  - [Drop.Duration](/Drop.Duration)
+  - [Drop.Style](/Drop.Style)
+  - [Drops](/Drops)
+
+</details>

Drops.xcodeproj/project.pbxproj

@@ -535,7 +535,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 0.2.0;
+				MARKETING_VERSION = 0.3.0;
 				PRODUCT_BUNDLE_IDENTIFIER = com.omaralbeik.drops;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;
@@ -564,7 +564,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 0.2.0;
+				MARKETING_VERSION = 0.3.0;
 				PRODUCT_BUNDLE_IDENTIFIER = com.omaralbeik.drops;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				SKIP_INSTALL = YES;

Sources/Drops.swift

@@ -27,6 +27,7 @@ typealias AnimationCompletion = (_ completed: Bool) -> Void
 
 private let sharedInstance = Drops()
 
+/// Drops.
 public final class Drops {
     private func show(drop: Drop) {
         let presenter = Presenter(drop: drop, delegate: self)
@@ -140,14 +141,18 @@ extension Drops: AnimatorDelegate {
 }
 
 public extension Drops {
+    /// Show a drop.
+    /// - Parameter drop: `Drop` to show.
     static func show(_ drop: Drop) {
         sharedInstance.show(drop: drop)
     }
 
+    /// Hide all drops.
     static func hideAll() {
         sharedInstance.hideAll()
     }
 
+    /// Hide currently shown drop.
     static func hideCurrent() {
         sharedInstance.hideCurrent()
     }