Skip to content

Commit

Permalink
Fixed documentation comments by adding closing tags so that the lates…
Browse files Browse the repository at this point in the history
…t version of ASDoc can properly parse PureMVC.
  • Loading branch information
bluntcoder committed Jul 22, 2013
1 parent ea14f8f commit 9d76e41
Show file tree
Hide file tree
Showing 12 changed files with 37 additions and 38 deletions.
10 changes: 5 additions & 5 deletions src/org/puremvc/as3/core/Controller.as
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ package org.puremvc.as3.core
* <P>
* In PureMVC, the <code>Controller</code> class follows the
* 'Command and Controller' strategy, and assumes these
* responsibilities:
* responsibilities:</P>
* <UL>
* <LI> Remembering which <code>ICommand</code>s
* are intended to handle which <code>INotifications</code>.</LI>
Expand All @@ -29,11 +29,11 @@ package org.puremvc.as3.core
*
* <P>
* Your application must register <code>ICommands</code> with the
* Controller.
* Controller.</P>
* <P>
* The simplest way is to subclass </code>Facade</code>,
* The simplest way is to subclass <code>Facade</code>,
* and use its <code>initializeController</code> method to add your
* registrations.
* registrations. </P>
*
* @see org.puremvc.as3.core.view.View View
* @see org.puremvc.as3.patterns.observer.Observer Observer
Expand All @@ -51,7 +51,7 @@ package org.puremvc.as3.core
* This <code>IController</code> implementation is a Singleton,
* so you should not call the constructor
* directly, but instead call the static Singleton
* Factory method <code>Controller.getInstance()</code>
* Factory method <code>Controller.getInstance()</code></P>
*
* @throws Error Error if Singleton instance has already been constructed
*
Expand Down
6 changes: 3 additions & 3 deletions src/org/puremvc/as3/core/Model.as
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ package org.puremvc.as3.core
*
* <P>
* In PureMVC, the <code>Model</code> class provides
* access to model objects (Proxies) by named lookup.
* access to model objects (Proxies) by named lookup. </P>
*
* <P>
* The <code>Model</code> assumes these responsibilities:</P>
Expand All @@ -28,7 +28,7 @@ package org.puremvc.as3.core
* with the <code>Model</code>. Typically, you use an
* <code>ICommand</code> to create and register <code>IProxy</code>
* instances once the <code>Facade</code> has initialized the Core
* actors.</p>
* actors.</P>
*
* @see org.puremvc.as3.patterns.proxy.Proxy Proxy
* @see org.puremvc.as3.interfaces.IProxy IProxy
Expand All @@ -42,7 +42,7 @@ package org.puremvc.as3.core
* This <code>IModel</code> implementation is a Singleton,
* so you should not call the constructor
* directly, but instead call the static Singleton
* Factory method <code>Model.getInstance()</code>
* Factory method <code>Model.getInstance()</code></P>
*
* @throws Error Error if Singleton instance has already been constructed
*
Expand Down
8 changes: 4 additions & 4 deletions src/org/puremvc/as3/core/View.as
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ package org.puremvc.as3.core
* A Singleton <code>IView</code> implementation.
*
* <P>
* In PureMVC, the <code>View</code> class assumes these responsibilities:
* In PureMVC, the <code>View</code> class assumes these responsibilities:</P>
* <UL>
* <LI>Maintain a cache of <code>IMediator</code> instances.</LI>
* <LI>Provide methods for registering, retrieving, and removing <code>IMediators</code>.</LI>
Expand All @@ -37,7 +37,7 @@ package org.puremvc.as3.core
* This <code>IView</code> implementation is a Singleton,
* so you should not call the constructor
* directly, but instead call the static Singleton
* Factory method <code>View.getInstance()</code>
* Factory method <code>View.getInstance()</code></P>
*
* @throws Error Error if Singleton instance has already been constructed
*
Expand Down Expand Up @@ -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.
* <P>
*
* @param notificationName which observer list to remove from
* @param notifyContext remove the observer with this object as its notifyContext
*/
Expand Down Expand Up @@ -169,7 +169,7 @@ package org.puremvc.as3.core
* names to be notified about, an <code>Observer</code> is created encapsulating
* the <code>IMediator</code> instance's <code>handleNotification</code> method
* and registering it as an <code>Observer</code> for all <code>INotifications</code> the
* <code>IMediator</code> is interested in.</p>
* <code>IMediator</code> is interested in.</P>
*
* @param mediatorName the name to associate with this <code>IMediator</code> instance
* @param mediator a reference to the <code>IMediator</code> instance
Expand Down
2 changes: 1 addition & 1 deletion src/org/puremvc/as3/interfaces/IController.as
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ package org.puremvc.as3.interfaces
* <P>
* In PureMVC, an <code>IController</code> implementor
* follows the 'Command and Controller' strategy, and
* assumes these responsibilities:
* assumes these responsibilities:</P>
* <UL>
* <LI> Remembering which <code>ICommand</code>s
* are intended to handle which <code>INotifications</code>.</LI>
Expand Down
2 changes: 1 addition & 1 deletion src/org/puremvc/as3/interfaces/IMediator.as
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ package org.puremvc.as3.interfaces
* <LI>In Flash-based apps, this is often the place where event listeners are
* added to view components, and their handlers implemented.</LI>
* <LI>Respond to and generate <code>INotifications</code>, interacting with of
* the rest of the PureMVC app.
* the rest of the PureMVC app.</LI>
* </UL></P>
* <P>
* When an <code>IMediator</code> is registered with the <code>IView</code>,
Expand Down
2 changes: 1 addition & 1 deletion src/org/puremvc/as3/interfaces/INotification.as
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ package org.puremvc.as3.interfaces
* PureMVC <code>Notification</code>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 <code>Notification</code>s.
* using <code>Notification</code>s.</P>
*
* @see org.puremvc.as3.interfaces.IView IView
* @see org.puremvc.as3.interfaces.IObserver IObserver
Expand Down
6 changes: 3 additions & 3 deletions src/org/puremvc/as3/interfaces/IObserver.as
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ package org.puremvc.as3.interfaces
* The interface definition for a PureMVC Observer.
*
* <P>
* In PureMVC, <code>IObserver</code> implementors assume these responsibilities:
* In PureMVC, <code>IObserver</code> implementors assume these responsibilities:</P>
* <UL>
* <LI>Encapsulate the notification (callback) method of the interested object.</LI>
* <LI>Encapsulate the notification context (this) of the interested object.</LI>
Expand All @@ -32,8 +32,8 @@ package org.puremvc.as3.interfaces
* <P>
* An Observer is an object that encapsulates information
* about an interested object with a notification method that
* should be called when an </code>INotification</code> is broadcast. The Observer then
* acts as a proxy for notifying the interested object.
* should be called when an <code>INotification</code> is broadcast. The Observer then
* acts as a proxy for notifying the interested object.</P>
*
* <P>
* Observers can receive <code>Notification</code>s by having their
Expand Down
6 changes: 3 additions & 3 deletions src/org/puremvc/as3/interfaces/IView.as
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ package org.puremvc.as3.interfaces
* In PureMVC, <code>IView</code> implementors assume these responsibilities:</P>
*
* <P>
* In PureMVC, the <code>View</code> class assumes these responsibilities:
* In PureMVC, the <code>View</code> class assumes these responsibilities:</P>
* <UL>
* <LI>Maintain a cache of <code>IMediator</code> instances.</LI>
* <LI>Provide methods for registering, retrieving, and removing <code>IMediators</code>.</LI>
Expand Down Expand Up @@ -40,7 +40,7 @@ package org.puremvc.as3.interfaces

/**
* Remove a group of observers from the observer list for a given Notification name.
* <P>
*
* @param notificationName which observer list to remove from
* @param notifyContext removed the observers with this object as their notifyContext
*/
Expand Down Expand Up @@ -70,7 +70,7 @@ package org.puremvc.as3.interfaces
* names to be notified about, an <code>Observer</code> is created encapsulating
* the <code>IMediator</code> instance's <code>handleNotification</code> method
* and registering it as an <code>Observer</code> for all <code>INotifications</code> the
* <code>IMediator</code> is interested in.</p>
* <code>IMediator</code> is interested in.</P>
*
* @param mediatorName the name to associate with this <code>IMediator</code> instance
* @param mediator a reference to the <code>IMediator</code> instance
Expand Down
25 changes: 12 additions & 13 deletions src/org/puremvc/as3/patterns/facade/Facade.as
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ package org.puremvc.as3.patterns.facade
*
* <P>
* In PureMVC, the <code>Facade</code> class assumes these
* responsibilities:
* responsibilities:</P>
* <UL>
* <LI>Initializing the <code>Model</code>, <code>View</code>
* and <code>Controller</code> Singletons.</LI>
* <LI>Providing all the methods defined by the <code>IModel,
* IView, & IController</code> interfaces.</LI>
* IView, and IController</code> interfaces.</LI>
* <LI>Providing the ability to override the specific <code>Model</code>,
* <code>View</code> and <code>Controller</code> Singletons created.</LI>
* <LI>Providing a single point of contact to the application for
* registering <code>Commands</code> and notifying <code>Observers</code></LI>
* </UL>
* <P>
* Example usage:
* Example usage:</P>
* <listing>
* import org.puremvc.as3.patterns.facade.&lowast;;
* import org.puremvc.as3.patterns.facade.Facade;
*
* import com.me.myapp.model.~~;
* import com.me.myapp.view.~~;
Expand Down Expand Up @@ -136,7 +136,7 @@ package org.puremvc.as3.patterns.facade
* This <code>IFacade</code> implementation is a Singleton,
* so you should not call the constructor
* directly, but instead call the static Singleton
* Factory method <code>Facade.getInstance()</code>
* Factory method <code>Facade.getInstance()</code></P>
*
* @throws Error Error if Singleton instance has already been constructed
*
Expand Down Expand Up @@ -177,15 +177,14 @@ package org.puremvc.as3.patterns.facade
* <P>
* Called by the <code>initializeFacade</code> method.
* Override this method in your subclass of <code>Facade</code>
* if one or both of the following are true:
* if one or both of the following are true:</P>
* <UL>
* <LI> You wish to initialize a different <code>IController</code>.</LI>
* <LI> You have <code>Commands</code> to register with the <code>Controller</code> at startup.</code>. </LI>
* <LI> You have <code>Commands</code> to register with the <code>Controller</code> at startup. </LI>
* </UL>
* If you don't want to initialize a different <code>IController</code>,
* call <code>super.initializeController()</code> at the beginning of your
* method, then register <code>Command</code>s.
* </P>
*/
protected function initializeController( ):void {
if ( controller != null ) return;
Expand All @@ -198,11 +197,11 @@ package org.puremvc.as3.patterns.facade
* <P>
* Called by the <code>initializeFacade</code> method.
* Override this method in your subclass of <code>Facade</code>
* if one or both of the following are true:
* if one or both of the following are true: </P>
* <UL>
* <LI> You wish to initialize a different <code>IModel</code>.</LI>
* <LI> You have <code>Proxy</code>s to register with the Model that do not
* retrieve a reference to the Facade at construction time.</code></LI>
* retrieve a reference to the Facade at construction time.</LI>
* </UL>
* If you don't want to initialize a different <code>IModel</code>,
* call <code>super.initializeModel()</code> at the beginning of your
Expand All @@ -227,7 +226,7 @@ package org.puremvc.as3.patterns.facade
* <P>
* Called by the <code>initializeFacade</code> method.
* Override this method in your subclass of <code>Facade</code>
* if one or both of the following are true:
* if one or both of the following are true:</P>
* <UL>
* <LI> You wish to initialize a different <code>IView</code>.</LI>
* <LI> You have <code>Observers</code> to register with the <code>View</code></LI>
Expand Down Expand Up @@ -377,7 +376,7 @@ package org.puremvc.as3.patterns.facade
*
* <P>
* Keeps us from having to construct new notification
* instances in our implementation code.
* instances in our implementation code. </P>
* @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)
Expand All @@ -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.</P>
*<P>
* <P>
* Usually you should just call sendNotification
* and pass the parameters, never having to
* construct the notification yourself.</P>
Expand Down
2 changes: 1 addition & 1 deletion src/org/puremvc/as3/patterns/observer/Notification.as
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ package org.puremvc.as3.patterns.observer
* PureMVC <code>Notification</code>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 <code>Notification</code>s.
* using <code>Notification</code>s.</P>
*
* @see org.puremvc.as3.patterns.observer.Observer Observer
*
Expand Down
4 changes: 2 additions & 2 deletions src/org/puremvc/as3/patterns/observer/Notifier.as
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ package org.puremvc.as3.patterns.observer
*
* <P>
* <code>MacroCommand, Command, Mediator</code> and <code>Proxy</code>
* all have a need to send <code>Notifications</code>. <P>
* all have a need to send <code>Notifications</code>. </P>
* <P>
* The <code>INotifier</code> interface provides a common method called
* <code>sendNotification</code> that relieves implementation code of
Expand All @@ -39,7 +39,7 @@ package org.puremvc.as3.patterns.observer
*
* <P>
* Keeps us from having to construct new INotification
* instances in our implementation code.
* instances in our implementation code.</P>
* @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)
Expand Down
2 changes: 1 addition & 1 deletion src/org/puremvc/as3/patterns/observer/Observer.as
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ package org.puremvc.as3.patterns.observer
* <LI>Encapsulate the notification context (this) of the interested object.</LI>
* <LI>Provide methods for setting the notification method and context.</LI>
* <LI>Provide a method for notifying the interested object.</LI>
* </UL>
* </UL></P>
*
* @see org.puremvc.as3.core.view.View View
* @see org.puremvc.as3.patterns.observer.Notification Notification
Expand Down

0 comments on commit 9d76e41

Please sign in to comment.