update

docs update

Author: saadshams

Package.swift

@@ -14,6 +14,7 @@ let package = Package(
     dependencies: [
         // Dependencies declare other packages that this package depends on.
         // .package(url: /* package url */, from: "1.0.0"),
+        .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.1.0"),
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.

Sources/PureMVC/core/Controller.swift

@@ -68,7 +68,7 @@ open class Controller: IController {
     so you should not call the constructor
     directly, but instead call the static Factory method,
     passing the unique key for this instance
-    `Controller.getInstance( multitonKey )`
+    `Controller.getInstance(multitonKey) { key in Controller(key: key) }`
 
     @throws Error if instance for this Multiton key has already been constructed
     */
@@ -91,7 +91,7 @@ open class Controller: IController {
 
         // ensure that the Controller is talking to my IView implementation
         override public func initializeController(  ) {
-            view = MyView.getInstance(multitonKey) { MyView(key: self.multitonKey) }
+            view = MyView.getInstance(multitonKey) { key in MyView(key: key) }
         }
     */
     open func initializeController() {
@@ -183,7 +183,7 @@ open class Controller: IController {
     /**
     Remove an IController instance
 
-    - parameter multitonKey: of IController instance to remove
+    - parameter key: of IController instance to remove
     */
     open class func removeController(_ key: String) {
         instanceQueue.sync(flags: .barrier) {

Sources/PureMVC/core/Model.swift

@@ -153,7 +153,7 @@ open class Model: IModel {
     /**
     Remove an IModel instance
 
-    - parameter multitonKey: of IModel instance to remove
+    - parameter key: of IModel instance to remove
     */
     open class func removeModel(_ key: String) {
         instanceQueue.sync(flags: .barrier) {

Sources/PureMVC/core/View.swift

@@ -262,7 +262,7 @@ open class View: IView {
     /**
     Remove an IView instance
 
-    - parameter multitonKey: of IView instance to remove
+    - parameter key: of IView instance to remove
     */
     open class func removeView(_ key: String) {
         instanceQueue.sync(flags: .barrier) {

Sources/PureMVC/interfaces/ICommand.swift

@@ -16,7 +16,7 @@ public protocol ICommand: INotifier {
     /**
     Execute the `ICommand`'s logic to handle a given `INotification`.
 
-    - parameter note: an `INotification` to handle.
+    - parameter notification: an `INotification` to handle.
     */
     func execute(_ notification: INotification)
 

Sources/PureMVC/interfaces/IController.swift

@@ -34,7 +34,7 @@ public protocol IController {
     for a particular `INotification`.
 
     - parameter notificationName: the name of the `INotification`
-    - parameter closure: reference that returns `ICommand`
+    - parameter factory: reference that returns `ICommand`
     */
     func registerCommand(_ notificationName: String, factory: @escaping () -> ICommand)
 

Sources/PureMVC/interfaces/IFacade.swift

@@ -63,7 +63,7 @@ public protocol IFacade: INotifier {
     /**
     Register an `ICommand` with the `Controller`.
 
-    - parameter noteName: the name of the `INotification` to associate the `ICommand` with.
+    - parameter notificationName: the name of the `INotification` to associate the `ICommand` with.
     - parameter factory: closure that returns `ICommand`
     */
     func registerCommand(_ notificationName: String, factory: @escaping () -> ICommand)

Sources/PureMVC/interfaces/IModel.swift

@@ -27,7 +27,6 @@ public protocol IModel {
     /**
     Register an `IProxy` instance with the `Model`.
 
-    - parameter proxyName: the name to associate with this `IProxy` instance.
     - parameter proxy: an object reference to be held by the `Model`.
     */
     func registerProxy(_ proxy: IProxy)

Sources/PureMVC/interfaces/IView.swift

@@ -74,7 +74,6 @@ public protocol IView {
     and registering it as an `Observer` for all `INotifications` the
     `IMediator` is interested in.
 
-    - parameter mediatorName: the name to associate with this `IMediator` instance
     - parameter mediator: a reference to the `IMediator` instance
     */
     func registerMediator(_ mediator: IMediator)