From 9d76e41745dd70d1f36c57a8558ec6959fa2310c Mon Sep 17 00:00:00 2001
From: bluntcoder
Date: Mon, 22 Jul 2013 14:50:29 -0400
Subject: [PATCH] Fixed documentation comments by adding closing tags so that
the latest version of ASDoc can properly parse PureMVC.
---
src/org/puremvc/as3/core/Controller.as | 10 ++++----
src/org/puremvc/as3/core/Model.as | 6 ++---
src/org/puremvc/as3/core/View.as | 8 +++---
src/org/puremvc/as3/interfaces/IController.as | 2 +-
src/org/puremvc/as3/interfaces/IMediator.as | 2 +-
.../puremvc/as3/interfaces/INotification.as | 2 +-
src/org/puremvc/as3/interfaces/IObserver.as | 6 ++---
src/org/puremvc/as3/interfaces/IView.as | 6 ++---
src/org/puremvc/as3/patterns/facade/Facade.as | 25 +++++++++----------
.../as3/patterns/observer/Notification.as | 2 +-
.../puremvc/as3/patterns/observer/Notifier.as | 4 +--
.../puremvc/as3/patterns/observer/Observer.as | 2 +-
12 files changed, 37 insertions(+), 38 deletions(-)
diff --git a/src/org/puremvc/as3/core/Controller.as b/src/org/puremvc/as3/core/Controller.as
index 6c04e75..2bfd7e9 100644
--- a/src/org/puremvc/as3/core/Controller.as
+++ b/src/org/puremvc/as3/core/Controller.as
@@ -14,7 +14,7 @@ package org.puremvc.as3.core
*
* In PureMVC, the
* Your application must register
- * The simplest way is to subclass Facade,
+ * The simplest way is to subclass Controller
class follows the
* 'Command and Controller' strategy, and assumes these
- * responsibilities:
+ * responsibilities:
*
ICommand
s
* are intended to handle which INotifications
.ICommands
with the
- * Controller.
+ * Controller.Facade
,
* and use its initializeController
method to add your
- * registrations.
+ * registrations. IController
implementation is a Singleton,
* so you should not call the constructor
* directly, but instead call the static Singleton
- * Factory method Controller.getInstance()
+ * Factory method Controller.getInstance()
* In PureMVC, the Model
class provides
- * access to model objects (Proxies) by named lookup.
+ * access to model objects (Proxies) by named lookup.
* The Model
assumes these responsibilities:
Model
. Typically, you use an
* ICommand
to create and register IProxy
* instances once the Facade
has initialized the Core
- * actors.
+ * actors.
*
* @see org.puremvc.as3.patterns.proxy.Proxy Proxy
* @see org.puremvc.as3.interfaces.IProxy IProxy
@@ -42,7 +42,7 @@ package org.puremvc.as3.core
* This IModel
implementation is a Singleton,
* so you should not call the constructor
* directly, but instead call the static Singleton
- * Factory method Model.getInstance()
+ * Factory method Model.getInstance()
*
* @throws Error Error if Singleton instance has already been constructed
*
diff --git a/src/org/puremvc/as3/core/View.as b/src/org/puremvc/as3/core/View.as
index e79e5a4..dcf19c5 100644
--- a/src/org/puremvc/as3/core/View.as
+++ b/src/org/puremvc/as3/core/View.as
@@ -12,7 +12,7 @@ package org.puremvc.as3.core
* A Singleton IView
implementation.
*
*
- * In PureMVC, the View
class assumes these responsibilities:
+ * In PureMVC, the View
class assumes these responsibilities:
IMediator
instances.IMediators
.IView
implementation is a Singleton,
* so you should not call the constructor
* directly, but instead call the static Singleton
- * Factory method View.getInstance()
+ * Factory method View.getInstance()
*
* @throws Error Error if Singleton instance has already been constructed
*
@@ -130,7 +130,7 @@ package org.puremvc.as3.core
/**
* Remove the observer for a given notifyContext from an observer list for a given Notification name.
- *
+ *
* @param notificationName which observer list to remove from
* @param notifyContext remove the observer with this object as its notifyContext
*/
@@ -169,7 +169,7 @@ package org.puremvc.as3.core
* names to be notified about, an Observer
is created encapsulating
* the IMediator
instance's handleNotification
method
* and registering it as an Observer
for all INotifications
the
- * IMediator
is interested in.
IMediator
is interested in.
*
* @param mediatorName the name to associate with this IMediator
instance
* @param mediator a reference to the IMediator
instance
diff --git a/src/org/puremvc/as3/interfaces/IController.as b/src/org/puremvc/as3/interfaces/IController.as
index eecc3ef..0385fae 100644
--- a/src/org/puremvc/as3/interfaces/IController.as
+++ b/src/org/puremvc/as3/interfaces/IController.as
@@ -10,7 +10,7 @@ package org.puremvc.as3.interfaces
*
* In PureMVC, an IController
implementor
* follows the 'Command and Controller' strategy, and
- * assumes these responsibilities:
+ * assumes these responsibilities:
ICommand
s
* are intended to handle which INotifications
.INotifications
, interacting with of
- * the rest of the PureMVC app.
+ * the rest of the PureMVC app.
* When an IMediator
is registered with the IView
,
diff --git a/src/org/puremvc/as3/interfaces/INotification.as b/src/org/puremvc/as3/interfaces/INotification.as
index 2b81ad1..8f6a3db 100644
--- a/src/org/puremvc/as3/interfaces/INotification.as
+++ b/src/org/puremvc/as3/interfaces/INotification.as
@@ -34,7 +34,7 @@ package org.puremvc.as3.interfaces
* PureMVC Notification
s follow a 'Publish/Subscribe'
* pattern. PureMVC classes need not be related to each other in a
* parent/child relationship in order to communicate with one another
- * using Notification
s.
+ * using Notification
s.
- * In PureMVC, IObserver
implementors assume these responsibilities:
+ * In PureMVC, IObserver
implementors assume these responsibilities:
* An Observer is an object that encapsulates information
* about an interested object with a notification method that
- * should be called when an INotification is broadcast. The Observer then
- * acts as a proxy for notifying the interested object.
+ * should be called when an INotification
is broadcast. The Observer then
+ * acts as a proxy for notifying the interested object.
* Observers can receive Notification
s by having their
diff --git a/src/org/puremvc/as3/interfaces/IView.as b/src/org/puremvc/as3/interfaces/IView.as
index e3b073b..f9954e9 100644
--- a/src/org/puremvc/as3/interfaces/IView.as
+++ b/src/org/puremvc/as3/interfaces/IView.as
@@ -12,7 +12,7 @@ package org.puremvc.as3.interfaces
* In PureMVC, IView
implementors assume these responsibilities:
- * In PureMVC, the View
class assumes these responsibilities:
+ * In PureMVC, the View
class assumes these responsibilities:
IMediator
instances.IMediators
.
+ *
* @param notificationName which observer list to remove from
* @param notifyContext removed the observers with this object as their notifyContext
*/
@@ -70,7 +70,7 @@ package org.puremvc.as3.interfaces
* names to be notified about, an Observer
is created encapsulating
* the IMediator
instance's handleNotification
method
* and registering it as an Observer
for all INotifications
the
- * IMediator
is interested in.
IMediator
is interested in.
*
* @param mediatorName the name to associate with this IMediator
instance
* @param mediator a reference to the IMediator
instance
diff --git a/src/org/puremvc/as3/patterns/facade/Facade.as b/src/org/puremvc/as3/patterns/facade/Facade.as
index 56a3b78..f5bea4a 100644
--- a/src/org/puremvc/as3/patterns/facade/Facade.as
+++ b/src/org/puremvc/as3/patterns/facade/Facade.as
@@ -14,21 +14,21 @@ package org.puremvc.as3.patterns.facade
*
*
* In PureMVC, the Facade
class assumes these
- * responsibilities:
+ * responsibilities:
Model
, View
* and Controller
Singletons.IModel,
- * IView, & IController
interfaces.Model
,
* View
and Controller
Singletons created.Commands
and notifying Observers
- * Example usage: + * Example usage:
*IFacade
implementation is a Singleton,
* so you should not call the constructor
* directly, but instead call the static Singleton
- * Factory method Facade.getInstance()
+ * Factory method Facade.getInstance()
*
* @throws Error Error if Singleton instance has already been constructed
*
@@ -177,15 +177,14 @@ package org.puremvc.as3.patterns.facade
*
* Called by the initializeFacade
method.
* Override this method in your subclass of Facade
- * if one or both of the following are true:
+ * if one or both of the following are true:
IController
.Commands
to register with the Controller
at startup.. Commands
to register with the Controller
at startup. IController
,
* call super.initializeController()
at the beginning of your
* method, then register Command
s.
- *
*/
protected function initializeController( ):void {
if ( controller != null ) return;
@@ -198,11 +197,11 @@ package org.puremvc.as3.patterns.facade
*
* Called by the initializeFacade
method.
* Override this method in your subclass of Facade
- * if one or both of the following are true:
+ * if one or both of the following are true:
IModel
.Proxy
s to register with the Model that do not
- * retrieve a reference to the Facade at construction time.IModel
,
* call super.initializeModel()
at the beginning of your
@@ -227,7 +226,7 @@ package org.puremvc.as3.patterns.facade
*
* Called by the initializeFacade
method.
* Override this method in your subclass of Facade
- * if one or both of the following are true:
+ * if one or both of the following are true:
IView
.Observers
to register with the View
* Keeps us from having to construct new notification - * instances in our implementation code. + * instances in our implementation code.
* @param notificationName the name of the notiification to send * @param body the body of the notification (optional) * @param type the type of the notification (optional) @@ -393,7 +392,7 @@ package org.puremvc.as3.patterns.facade * This method is left public mostly for backward * compatibility, and to allow you to send custom * notification classes using the facade. - *+ *
* Usually you should just call sendNotification * and pass the parameters, never having to * construct the notification yourself.
diff --git a/src/org/puremvc/as3/patterns/observer/Notification.as b/src/org/puremvc/as3/patterns/observer/Notification.as index f90a59c..a1b6626 100644 --- a/src/org/puremvc/as3/patterns/observer/Notification.as +++ b/src/org/puremvc/as3/patterns/observer/Notification.as @@ -36,7 +36,7 @@ package org.puremvc.as3.patterns.observer * PureMVCNotification
s follow a 'Publish/Subscribe'
* pattern. PureMVC classes need not be related to each other in a
* parent/child relationship in order to communicate with one another
- * using Notification
s.
+ * using Notification
s.
*
* @see org.puremvc.as3.patterns.observer.Observer Observer
*
diff --git a/src/org/puremvc/as3/patterns/observer/Notifier.as b/src/org/puremvc/as3/patterns/observer/Notifier.as
index 7f6053a..c4730d1 100644
--- a/src/org/puremvc/as3/patterns/observer/Notifier.as
+++ b/src/org/puremvc/as3/patterns/observer/Notifier.as
@@ -12,7 +12,7 @@ package org.puremvc.as3.patterns.observer
*
*
* MacroCommand, Command, Mediator
and Proxy
- * all have a need to send Notifications
.
+ * all have a need to send Notifications
.
* The INotifier
interface provides a common method called
* sendNotification
that relieves implementation code of
@@ -39,7 +39,7 @@ package org.puremvc.as3.patterns.observer
*
*
* Keeps us from having to construct new INotification - * instances in our implementation code. + * instances in our implementation code.
* @param notificationName the name of the notiification to send * @param body the body of the notification (optional) * @param type the type of the notification (optional) diff --git a/src/org/puremvc/as3/patterns/observer/Observer.as b/src/org/puremvc/as3/patterns/observer/Observer.as index 19e76db..57514bb 100644 --- a/src/org/puremvc/as3/patterns/observer/Observer.as +++ b/src/org/puremvc/as3/patterns/observer/Observer.as @@ -21,7 +21,7 @@ package org.puremvc.as3.patterns.observer *