update

updated docs

Author: saadshams

Sources/PureMVC/interfaces/INotifier.swift

@@ -39,28 +39,7 @@ public protocol INotifier {
     - parameter body: the body of the notification
     - parameter type: the type of the notification
     */
-    func sendNotification(_ notificationName: String, body: Any, type: String)
-    
-    /**
-    Send a `INotification`.
-    
-    Convenience method to prevent having to construct new
-    notification instances in our implementation code.
-    
-    - parameter notificationName: the name of the notification to send
-    - parameter body: the body of the notification
-    */
-    func sendNotification(_ notificationName: String, body: Any)
-    
-    /**
-    Send a `INotification`.
-    
-    Convenience method to prevent having to construct new
-    notification instances in our implementation code.
-    
-    - parameter notificationName: the name of the notification to send
-    */
-    func sendNotification(_ notificationName: String)
+    func sendNotification(_ notificationName: String, body: Any?, type: String?)
 
     /**
     Initialize this INotifier instance.

Sources/PureMVC/patterns/facade/Facade.swift

@@ -272,35 +272,10 @@ open class Facade: IFacade {
     - parameter body: the body of the notification (
     - parameter type: the type of the notification
     */
-    open func sendNotification(_ notificationName: String, body: Any, type: String) {
+    open func sendNotification(_ notificationName: String, body: Any? = nil, type: String? = nil) {
         notifyObservers(Notification(name: notificationName, body: body, type: type))
     }
 
-    /**
-    Create and send an `INotification`.
-    
-    Keeps us from having to construct new notification
-    instances in our implementation code.
-    
-    - parameter notificationName: the name of the notiification to send
-    - parameter body: the body of the notification (optional)
-    */
-    open func sendNotification(_ notificationName: String, body: Any) {
-        notifyObservers(Notification(name: notificationName, body: body))
-    }
-    
-    /**
-    Create and send an `INotification`.
-    
-    Keeps us from having to construct new notification
-    instances in our implementation code.
-    
-    - parameter notificationName: the name of the notiification to send
-    */
-    open func sendNotification(_ notificationName: String) {
-        notifyObservers(Notification(name: notificationName))
-    }
-    
     /**
     Notify `Observer`s.
 

Sources/PureMVC/patterns/observer/Notifier.swift

@@ -73,35 +73,10 @@ open class Notifier : INotifier {
     - parameter body: the body of the notification (optional)
     - parameter type: the type of the notification (optional)
     */
-    open func sendNotification(_ notificationName: String, body: Any, type: String) {
+    open func sendNotification(_ notificationName: String, body: Any? = nil, type: String? = nil) {
         facade?.sendNotification(notificationName, body: body, type: type)
     }
 
-    /**
-    Create and send an `INotification`.
-    
-    Keeps us from having to construct new INotification
-    instances in our implementation code.
-    
-    - parameter notificationName: the name of the notification to send
-    - parameter body: the body of the notification (optional)
-    */
-    open func sendNotification(_ notificationName: String, body: Any) {
-        facade?.sendNotification(notificationName, body: body)
-    }
-    
-    /**
-    Create and send an `INotification`.
-    
-    Keeps us from having to construct new INotification
-    instances in our implementation code.
-    
-    - parameter notificationName: the name of the notification to send
-    */
-    open func sendNotification(_ notificationName: String) {
-        facade?.sendNotification(notificationName)
-    }
-    
     /**
     Initialize this INotifier instance.
 

Tests/PureMVCTests/patterns/facade/FacadeTest.swift

@@ -58,7 +58,7 @@ class FacadeTest: XCTestCase {
         // (FacadeTestCommand) will be invoked, and will multiply
         // the vo.input value by 2 and set the result on vo.result
         let vo = FacadeTestVO(input: 32)
-        facade?.sendNotification("FacadeTestNote", body: vo)
+        facade?.sendNotification("FacadeTestNote", body: vo, type: nil)
 
         // test assertions
         XCTAssertTrue(vo.result == 64, "Expecting vo.result == 64)")

docs/data/documentation/puremvc.json

@@ -1 +1 @@
-{"abstract":[{"text":"If an ","type":"text"},{"code":"ICommand","type":"codeVoice"},{"text":" has previously been registered","type":"text"},{"text":" ","type":"text"},{"text":"to handle a the given ","type":"text"},{"code":"INotification","type":"codeVoice"},{"text":", then it is executed.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"executeCommand"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"notification"},{"kind":"text","text":": any "},{"identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/INotification","kind":"typeIdentifier","preciseIdentifier":"s:7PureMVC13INotificationP","text":"INotification"},{"kind":"text","text":")"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"notification","content":[{"type":"paragraph","inlineContent":[{"text":"An ","type":"text"},{"type":"codeVoice","code":"INotification"}]}]}]}],"hierarchy":{"paths":[["doc:\/\/PureMVC\/documentation\/PureMVC","doc:\/\/PureMVC\/documentation\/PureMVC\/Controller"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/executeCommand(_:)"},"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/puremvc\/controller\/executecommand(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"executeCommand","kind":"identifier"},{"text":"(any ","kind":"text"},{"preciseIdentifier":"s:7PureMVC13INotificationP","text":"INotification","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:7PureMVC10ControllerC14executeCommandyyAA13INotification_pF","modules":[{"name":"PureMVC"}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method","title":"executeCommand(_:)"},"references":{"doc://PureMVC/documentation/PureMVC/Controller/executeCommand(_:)":{"role":"symbol","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/executeCommand(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"executeCommand"},{"kind":"text","text":"(any "},{"kind":"typeIdentifier","text":"INotification","preciseIdentifier":"s:7PureMVC13INotificationP"},{"kind":"text","text":")"}],"type":"topic","abstract":[{"type":"text","text":"If an "},{"code":"ICommand","type":"codeVoice"},{"type":"text","text":" has previously been registered"},{"type":"text","text":" "},{"type":"text","text":"to handle a the given "},{"code":"INotification","type":"codeVoice"},{"type":"text","text":", then it is executed."}],"title":"executeCommand(_:)","kind":"symbol","url":"\/documentation\/puremvc\/controller\/executecommand(_:)"},"doc://PureMVC/documentation/PureMVC/INotification":{"title":"INotification","abstract":[{"type":"text","text":"The interface definition for a PureMVC Notification."}],"role":"symbol","url":"\/documentation\/puremvc\/inotification","navigatorTitle":[{"text":"INotification","kind":"identifier"}],"type":"topic","kind":"symbol","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/INotification","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"INotification","kind":"identifier"}]},"doc://PureMVC/documentation/PureMVC/Controller":{"url":"\/documentation\/puremvc\/controller","type":"topic","title":"Controller","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A Multiton "},{"type":"codeVoice","code":"IController"},{"type":"text","text":" implementation."}],"identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Controller","kind":"identifier"}],"navigatorTitle":[{"text":"Controller","kind":"identifier"}]},"doc://PureMVC/documentation/PureMVC":{"abstract":[],"url":"\/documentation\/puremvc","kind":"symbol","type":"topic","title":"PureMVC","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC","role":"collection"}}}
+{"abstract":[{"text":"If an ","type":"text"},{"type":"codeVoice","code":"ICommand"},{"text":" has previously been registered","type":"text"},{"text":" ","type":"text"},{"text":"to handle a the given ","type":"text"},{"type":"codeVoice","code":"INotification"},{"text":", then it is executed.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/PureMVC\/documentation\/PureMVC","doc:\/\/PureMVC\/documentation\/PureMVC\/Controller"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/puremvc\/controller\/executecommand(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"executeCommand","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"notification","kind":"internalParam"},{"text":": any ","kind":"text"},{"identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/INotification","text":"INotification","preciseIdentifier":"s:7PureMVC13INotificationP","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"notification","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An "},{"type":"codeVoice","code":"INotification"}]}]}]}],"metadata":{"role":"symbol","title":"executeCommand(_:)","symbolKind":"method","modules":[{"name":"PureMVC"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"executeCommand","kind":"identifier"},{"text":"(any ","kind":"text"},{"text":"INotification","kind":"typeIdentifier","preciseIdentifier":"s:7PureMVC13INotificationP"},{"text":")","kind":"text"}],"externalID":"s:7PureMVC10ControllerC14executeCommandyyAA13INotification_pF"},"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/executeCommand(_:)"},"references":{"doc://PureMVC/documentation/PureMVC/INotification":{"abstract":[{"type":"text","text":"The interface definition for a PureMVC Notification."}],"url":"\/documentation\/puremvc\/inotification","kind":"symbol","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"INotification","kind":"identifier"}],"identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/INotification","title":"INotification","type":"topic","navigatorTitle":[{"text":"INotification","kind":"identifier"}]},"doc://PureMVC/documentation/PureMVC/Controller/executeCommand(_:)":{"title":"executeCommand(_:)","kind":"symbol","url":"\/documentation\/puremvc\/controller\/executecommand(_:)","type":"topic","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/executeCommand(_:)","abstract":[{"type":"text","text":"If an "},{"type":"codeVoice","code":"ICommand"},{"type":"text","text":" has previously been registered"},{"type":"text","text":" "},{"type":"text","text":"to handle a the given "},{"type":"codeVoice","code":"INotification"},{"type":"text","text":", then it is executed."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"executeCommand"},{"kind":"text","text":"(any "},{"preciseIdentifier":"s:7PureMVC13INotificationP","kind":"typeIdentifier","text":"INotification"},{"kind":"text","text":")"}],"role":"symbol"},"doc://PureMVC/documentation/PureMVC/Controller":{"url":"\/documentation\/puremvc\/controller","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Controller"}],"abstract":[{"type":"text","text":"A Multiton "},{"code":"IController","type":"codeVoice"},{"type":"text","text":" implementation."}],"role":"symbol","type":"topic","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller","kind":"symbol","title":"Controller","navigatorTitle":[{"kind":"identifier","text":"Controller"}]},"doc://PureMVC/documentation/PureMVC":{"title":"PureMVC","url":"\/documentation\/puremvc","role":"collection","type":"topic","abstract":[],"kind":"symbol","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC"}}}