Add Action and ActionReducer docs

Author: minuscorp

Sources/Mini/Action.swift

@@ -16,7 +16,13 @@
 
 import Foundation
 
+/**
+ Protocol that has to be conformed by any object that can be dispatcher
+ by a `Dispatcher` object.
+ */
 public protocol Action {
+    /// Equality function between `Action` objects
+    /// - Returns: If an `Action` is the same as other.
     func isEqual(to other: Action) -> Bool
 }
 
@@ -40,12 +46,17 @@ extension Action {
 }
 
 extension Action {
+    /// Equality operator between `Action` objects.
+    /// - Returns: If the `Action`s are equal or not.
     public static func == (lhs: Self, rhs: Self) -> Bool {
         return lhs.isEqual(to: rhs)
     }
 }
 
 extension Action where Self: Equatable {
+    /// Convenience `isEqual` implementation when the `Action` object
+    /// implements `Equatable`.
+    /// - Returns: Whether the `Action` object is the same as other.
     public func isEqual(to other: Action) -> Bool {
         guard let action = other as? Self else { return false }
         return self == action

Sources/Mini/ActionReducer.swift

@@ -17,13 +17,27 @@
 import Foundation
 import RxSwift
 
+/**
+ The `Reducer` defines the behavior to be executed when a certain
+ `Action` object is received.
+ */
 public class Reducer<A: Action>: Disposable {
+    /// The `Action` type which the `Reducer` listens to.
     public let action: A.Type
+    /// The `Dispatcher` object that sends the `Action` objects.
     public let dispatcher: Dispatcher
+    /// The behavior to be executed when the `Dispatcher` sends a certain `Action`
     public let reducer: (A) -> Void
 
     private var disposable: Disposable!
 
+    /**
+     Initializes a new `Reducer` object.
+     - Parameter action: The `Action` type that will be listened to.
+     - Parameter dispatcher: The `Dispatcher` that sends the `Action`.
+     - Parameter reducer: The closure that will be executed when the `Dispatcher`
+     sends the defined `Action` type.
+     */
     public init(of action: A.Type, on dispatcher: Dispatcher, reducer: @escaping (A) -> Void) {
         self.action = action
         self.dispatcher = dispatcher
@@ -38,6 +52,7 @@ public class Reducer<A: Action>: Disposable {
         return disposable
     }
 
+    /// Dispose resource.
     public func dispose() {
         disposable.dispose()
     }