Skip to content

Commit ea78705

Browse files
committed
update
updated docs
1 parent 27f5293 commit ea78705

File tree

158 files changed

+159
-157
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

158 files changed

+159
-157
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ swift package --allow-writing-to-directory ./docs \
1212
--transform-for-static-hosting \
1313
--hosting-base-path puremvc-swift-multicore-framework \
1414
--output-path ./docs
15+
16+
open docs/documentation/puremvc/index.html
1517
-->
1618

1719
## Demos

docs/data/documentation/puremvc.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/data/documentation/puremvc/controller.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"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"}}}
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":[{"kind":"declarations","declarations":[{"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","text":"INotification","preciseIdentifier":"s:7PureMVC13INotificationP"},{"kind":"text","text":")"}],"platforms":["macOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"An ","type":"text"},{"type":"codeVoice","code":"INotification"}]}],"name":"notification"}],"kind":"parameters"}],"metadata":{"symbolKind":"method","modules":[{"name":"PureMVC"}],"role":"symbol","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","roleHeading":"Instance Method","title":"executeCommand(_:)"},"identifier":{"url":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/executeCommand(_:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/puremvc\/controller\/executecommand(_:)"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/PureMVC\/documentation\/PureMVC","doc:\/\/PureMVC\/documentation\/PureMVC\/Controller"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"references":{"doc://PureMVC/documentation/PureMVC/Controller/executeCommand(_:)":{"role":"symbol","type":"topic","kind":"symbol","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"}],"title":"executeCommand(_:)","url":"\/documentation\/puremvc\/controller\/executecommand(_:)","abstract":[{"text":"If an ","type":"text"},{"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."}],"identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/executeCommand(_:)"},"doc://PureMVC/documentation/PureMVC/Controller":{"abstract":[{"text":"A Multiton ","type":"text"},{"code":"IController","type":"codeVoice"},{"text":" implementation.","type":"text"}],"fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Controller","kind":"identifier"}],"title":"Controller","type":"topic","role":"symbol","kind":"symbol","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller","url":"\/documentation\/puremvc\/controller","navigatorTitle":[{"text":"Controller","kind":"identifier"}]},"doc://PureMVC/documentation/PureMVC/INotification":{"url":"\/documentation\/puremvc\/inotification","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"INotification"}],"role":"symbol","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/INotification","kind":"symbol","abstract":[{"type":"text","text":"The interface definition for a PureMVC Notification."}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"INotification"}],"title":"INotification"},"doc://PureMVC/documentation/PureMVC":{"identifier":"doc:\/\/PureMVC\/documentation\/PureMVC","type":"topic","title":"PureMVC","url":"\/documentation\/puremvc","abstract":[],"kind":"symbol","role":"collection"}}}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getInstance"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"factory"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> any "},{"kind":"typeIdentifier","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/IController","preciseIdentifier":"s:7PureMVC11IControllerP","text":"IController"},{"kind":"text","text":") -> (any "},{"kind":"typeIdentifier","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/IController","preciseIdentifier":"s:7PureMVC11IControllerP","text":"IController"},{"kind":"text","text":")?"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"multitonKey"}]}],"name":"key"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Reference that returns "},{"type":"codeVoice","code":"IController"}]}],"name":"factory"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The Multiton instance","type":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/PureMVC\/documentation\/PureMVC","doc:\/\/PureMVC\/documentation\/PureMVC\/Controller"]]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/getInstance(_:factory:)","interfaceLanguage":"swift"},"abstract":[{"type":"codeVoice","code":"Controller"},{"text":" Multiton Factory method.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/puremvc\/controller\/getinstance(_:factory:)"]}],"metadata":{"role":"symbol","externalID":"s:7PureMVC10ControllerC11getInstance_7factoryAA11IController_pSgSS_AaF_pSSXEtFZ","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getInstance","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"factory"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> any "},{"kind":"typeIdentifier","text":"IController","preciseIdentifier":"s:7PureMVC11IControllerP"},{"kind":"text","text":") -> (any "},{"kind":"typeIdentifier","text":"IController","preciseIdentifier":"s:7PureMVC11IControllerP"},{"kind":"text","text":")?"}],"title":"getInstance(_:factory:)","roleHeading":"Type Method","symbolKind":"method","modules":[{"name":"PureMVC"}]},"references":{"doc://PureMVC/documentation/PureMVC/Controller/getInstance(_:factory:)":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getInstance"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"factory"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> any "},{"preciseIdentifier":"s:7PureMVC11IControllerP","kind":"typeIdentifier","text":"IController"},{"kind":"text","text":") -> (any "},{"preciseIdentifier":"s:7PureMVC11IControllerP","kind":"typeIdentifier","text":"IController"},{"kind":"text","text":")?"}],"role":"symbol","kind":"symbol","title":"getInstance(_:factory:)","abstract":[{"type":"codeVoice","code":"Controller"},{"type":"text","text":" Multiton Factory method."}],"type":"topic","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/getInstance(_:factory:)","url":"\/documentation\/puremvc\/controller\/getinstance(_:factory:)"},"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/IController":{"abstract":[{"text":"The interface definition for a PureMVC Controller.","type":"text"}],"identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/IController","role":"symbol","title":"IController","type":"topic","url":"\/documentation\/puremvc\/icontroller","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"IController","kind":"identifier"}],"navigatorTitle":[{"text":"IController","kind":"identifier"}],"kind":"symbol"},"doc://PureMVC/documentation/PureMVC":{"title":"PureMVC","url":"\/documentation\/puremvc","role":"collection","type":"topic","abstract":[],"kind":"symbol","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC"}}}
1+
{"variants":[{"paths":["\/documentation\/puremvc\/controller\/getinstance(_:factory:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/getInstance(_:factory:)"},"hierarchy":{"paths":[["doc:\/\/PureMVC\/documentation\/PureMVC","doc:\/\/PureMVC\/documentation\/PureMVC\/Controller"]]},"metadata":{"role":"symbol","title":"getInstance(_:factory:)","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getInstance","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"factory","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> any ","kind":"text"},{"preciseIdentifier":"s:7PureMVC11IControllerP","text":"IController","kind":"typeIdentifier"},{"text":") -> (any ","kind":"text"},{"preciseIdentifier":"s:7PureMVC11IControllerP","text":"IController","kind":"typeIdentifier"},{"text":")?","kind":"text"}],"roleHeading":"Type Method","externalID":"s:7PureMVC10ControllerC11getInstance_7factoryAA11IController_pSgSS_AaF_pSSXEtFZ","modules":[{"name":"PureMVC"}],"symbolKind":"method"},"abstract":[{"type":"codeVoice","code":"Controller"},{"type":"text","text":" Multiton Factory method."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getInstance"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"factory"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> any "},{"preciseIdentifier":"s:7PureMVC11IControllerP","kind":"typeIdentifier","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/IController","text":"IController"},{"kind":"text","text":") -> (any "},{"preciseIdentifier":"s:7PureMVC11IControllerP","kind":"typeIdentifier","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/IController","text":"IController"},{"kind":"text","text":")?"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"multitonKey"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Reference that returns "},{"type":"codeVoice","code":"IController"}],"type":"paragraph"}],"name":"factory"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The Multiton instance"}],"type":"paragraph"}]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","references":{"doc://PureMVC/documentation/PureMVC":{"abstract":[],"title":"PureMVC","type":"topic","role":"collection","kind":"symbol","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC","url":"\/documentation\/puremvc"},"doc://PureMVC/documentation/PureMVC/Controller":{"abstract":[{"text":"A Multiton ","type":"text"},{"code":"IController","type":"codeVoice"},{"text":" implementation.","type":"text"}],"fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Controller","kind":"identifier"}],"title":"Controller","type":"topic","role":"symbol","kind":"symbol","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller","url":"\/documentation\/puremvc\/controller","navigatorTitle":[{"text":"Controller","kind":"identifier"}]},"doc://PureMVC/documentation/PureMVC/Controller/getInstance(_:factory:)":{"title":"getInstance(_:factory:)","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/Controller\/getInstance(_:factory:)","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getInstance","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"factory","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> any "},{"kind":"typeIdentifier","preciseIdentifier":"s:7PureMVC11IControllerP","text":"IController"},{"kind":"text","text":") -> (any "},{"preciseIdentifier":"s:7PureMVC11IControllerP","kind":"typeIdentifier","text":"IController"},{"kind":"text","text":")?"}],"abstract":[{"code":"Controller","type":"codeVoice"},{"text":" Multiton Factory method.","type":"text"}],"type":"topic","url":"\/documentation\/puremvc\/controller\/getinstance(_:factory:)"},"doc://PureMVC/documentation/PureMVC/IController":{"navigatorTitle":[{"text":"IController","kind":"identifier"}],"role":"symbol","kind":"symbol","url":"\/documentation\/puremvc\/icontroller","identifier":"doc:\/\/PureMVC\/documentation\/PureMVC\/IController","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"IController","kind":"identifier"}],"abstract":[{"text":"The interface definition for a PureMVC Controller.","type":"text"}],"title":"IController","type":"topic"}}}

0 commit comments

Comments
 (0)