Skip to content

Commit e2ba344

Browse files
committed
Merge pull request #1 from bluntcoder/asdoc
ASDoc fix
2 parents ea14f8f + 9d76e41 commit e2ba344

File tree

12 files changed

+37
-38
lines changed

12 files changed

+37
-38
lines changed

src/org/puremvc/as3/core/Controller.as

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ package org.puremvc.as3.core
1414
* <P>
1515
* In PureMVC, the <code>Controller</code> class follows the
1616
* 'Command and Controller' strategy, and assumes these
17-
* responsibilities:
17+
* responsibilities:</P>
1818
* <UL>
1919
* <LI> Remembering which <code>ICommand</code>s
2020
* are intended to handle which <code>INotifications</code>.</LI>
@@ -29,11 +29,11 @@ package org.puremvc.as3.core
2929
*
3030
* <P>
3131
* Your application must register <code>ICommands</code> with the
32-
* Controller.
32+
* Controller.</P>
3333
* <P>
34-
* The simplest way is to subclass </code>Facade</code>,
34+
* The simplest way is to subclass <code>Facade</code>,
3535
* and use its <code>initializeController</code> method to add your
36-
* registrations.
36+
* registrations. </P>
3737
*
3838
* @see org.puremvc.as3.core.view.View View
3939
* @see org.puremvc.as3.patterns.observer.Observer Observer
@@ -51,7 +51,7 @@ package org.puremvc.as3.core
5151
* This <code>IController</code> implementation is a Singleton,
5252
* so you should not call the constructor
5353
* directly, but instead call the static Singleton
54-
* Factory method <code>Controller.getInstance()</code>
54+
* Factory method <code>Controller.getInstance()</code></P>
5555
*
5656
* @throws Error Error if Singleton instance has already been constructed
5757
*

src/org/puremvc/as3/core/Model.as

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ package org.puremvc.as3.core
1212
*
1313
* <P>
1414
* In PureMVC, the <code>Model</code> class provides
15-
* access to model objects (Proxies) by named lookup.
15+
* access to model objects (Proxies) by named lookup. </P>
1616
*
1717
* <P>
1818
* The <code>Model</code> assumes these responsibilities:</P>
@@ -28,7 +28,7 @@ package org.puremvc.as3.core
2828
* with the <code>Model</code>. Typically, you use an
2929
* <code>ICommand</code> to create and register <code>IProxy</code>
3030
* instances once the <code>Facade</code> has initialized the Core
31-
* actors.</p>
31+
* actors.</P>
3232
*
3333
* @see org.puremvc.as3.patterns.proxy.Proxy Proxy
3434
* @see org.puremvc.as3.interfaces.IProxy IProxy
@@ -42,7 +42,7 @@ package org.puremvc.as3.core
4242
* This <code>IModel</code> implementation is a Singleton,
4343
* so you should not call the constructor
4444
* directly, but instead call the static Singleton
45-
* Factory method <code>Model.getInstance()</code>
45+
* Factory method <code>Model.getInstance()</code></P>
4646
*
4747
* @throws Error Error if Singleton instance has already been constructed
4848
*

src/org/puremvc/as3/core/View.as

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ package org.puremvc.as3.core
1212
* A Singleton <code>IView</code> implementation.
1313
*
1414
* <P>
15-
* In PureMVC, the <code>View</code> class assumes these responsibilities:
15+
* In PureMVC, the <code>View</code> class assumes these responsibilities:</P>
1616
* <UL>
1717
* <LI>Maintain a cache of <code>IMediator</code> instances.</LI>
1818
* <LI>Provide methods for registering, retrieving, and removing <code>IMediators</code>.</LI>
@@ -37,7 +37,7 @@ package org.puremvc.as3.core
3737
* This <code>IView</code> implementation is a Singleton,
3838
* so you should not call the constructor
3939
* directly, but instead call the static Singleton
40-
* Factory method <code>View.getInstance()</code>
40+
* Factory method <code>View.getInstance()</code></P>
4141
*
4242
* @throws Error Error if Singleton instance has already been constructed
4343
*
@@ -130,7 +130,7 @@ package org.puremvc.as3.core
130130

131131
/**
132132
* Remove the observer for a given notifyContext from an observer list for a given Notification name.
133-
* <P>
133+
*
134134
* @param notificationName which observer list to remove from
135135
* @param notifyContext remove the observer with this object as its notifyContext
136136
*/
@@ -169,7 +169,7 @@ package org.puremvc.as3.core
169169
* names to be notified about, an <code>Observer</code> is created encapsulating
170170
* the <code>IMediator</code> instance's <code>handleNotification</code> method
171171
* and registering it as an <code>Observer</code> for all <code>INotifications</code> the
172-
* <code>IMediator</code> is interested in.</p>
172+
* <code>IMediator</code> is interested in.</P>
173173
*
174174
* @param mediatorName the name to associate with this <code>IMediator</code> instance
175175
* @param mediator a reference to the <code>IMediator</code> instance

src/org/puremvc/as3/interfaces/IController.as

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ package org.puremvc.as3.interfaces
1010
* <P>
1111
* In PureMVC, an <code>IController</code> implementor
1212
* follows the 'Command and Controller' strategy, and
13-
* assumes these responsibilities:
13+
* assumes these responsibilities:</P>
1414
* <UL>
1515
* <LI> Remembering which <code>ICommand</code>s
1616
* are intended to handle which <code>INotifications</code>.</LI>

src/org/puremvc/as3/interfaces/IMediator.as

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ package org.puremvc.as3.interfaces
2424
* <LI>In Flash-based apps, this is often the place where event listeners are
2525
* added to view components, and their handlers implemented.</LI>
2626
* <LI>Respond to and generate <code>INotifications</code>, interacting with of
27-
* the rest of the PureMVC app.
27+
* the rest of the PureMVC app.</LI>
2828
* </UL></P>
2929
* <P>
3030
* When an <code>IMediator</code> is registered with the <code>IView</code>,

src/org/puremvc/as3/interfaces/INotification.as

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ package org.puremvc.as3.interfaces
3434
* PureMVC <code>Notification</code>s follow a 'Publish/Subscribe'
3535
* pattern. PureMVC classes need not be related to each other in a
3636
* parent/child relationship in order to communicate with one another
37-
* using <code>Notification</code>s.
37+
* using <code>Notification</code>s.</P>
3838
*
3939
* @see org.puremvc.as3.interfaces.IView IView
4040
* @see org.puremvc.as3.interfaces.IObserver IObserver

src/org/puremvc/as3/interfaces/IObserver.as

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ package org.puremvc.as3.interfaces
99
* The interface definition for a PureMVC Observer.
1010
*
1111
* <P>
12-
* In PureMVC, <code>IObserver</code> implementors assume these responsibilities:
12+
* In PureMVC, <code>IObserver</code> implementors assume these responsibilities:</P>
1313
* <UL>
1414
* <LI>Encapsulate the notification (callback) method of the interested object.</LI>
1515
* <LI>Encapsulate the notification context (this) of the interested object.</LI>
@@ -32,8 +32,8 @@ package org.puremvc.as3.interfaces
3232
* <P>
3333
* An Observer is an object that encapsulates information
3434
* about an interested object with a notification method that
35-
* should be called when an </code>INotification</code> is broadcast. The Observer then
36-
* acts as a proxy for notifying the interested object.
35+
* should be called when an <code>INotification</code> is broadcast. The Observer then
36+
* acts as a proxy for notifying the interested object.</P>
3737
*
3838
* <P>
3939
* Observers can receive <code>Notification</code>s by having their

src/org/puremvc/as3/interfaces/IView.as

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ package org.puremvc.as3.interfaces
1212
* In PureMVC, <code>IView</code> implementors assume these responsibilities:</P>
1313
*
1414
* <P>
15-
* In PureMVC, the <code>View</code> class assumes these responsibilities:
15+
* In PureMVC, the <code>View</code> class assumes these responsibilities:</P>
1616
* <UL>
1717
* <LI>Maintain a cache of <code>IMediator</code> instances.</LI>
1818
* <LI>Provide methods for registering, retrieving, and removing <code>IMediators</code>.</LI>
@@ -40,7 +40,7 @@ package org.puremvc.as3.interfaces
4040

4141
/**
4242
* Remove a group of observers from the observer list for a given Notification name.
43-
* <P>
43+
*
4444
* @param notificationName which observer list to remove from
4545
* @param notifyContext removed the observers with this object as their notifyContext
4646
*/
@@ -70,7 +70,7 @@ package org.puremvc.as3.interfaces
7070
* names to be notified about, an <code>Observer</code> is created encapsulating
7171
* the <code>IMediator</code> instance's <code>handleNotification</code> method
7272
* and registering it as an <code>Observer</code> for all <code>INotifications</code> the
73-
* <code>IMediator</code> is interested in.</p>
73+
* <code>IMediator</code> is interested in.</P>
7474
*
7575
* @param mediatorName the name to associate with this <code>IMediator</code> instance
7676
* @param mediator a reference to the <code>IMediator</code> instance

src/org/puremvc/as3/patterns/facade/Facade.as

+12-13
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ package org.puremvc.as3.patterns.facade
1414
*
1515
* <P>
1616
* In PureMVC, the <code>Facade</code> class assumes these
17-
* responsibilities:
17+
* responsibilities:</P>
1818
* <UL>
1919
* <LI>Initializing the <code>Model</code>, <code>View</code>
2020
* and <code>Controller</code> Singletons.</LI>
2121
* <LI>Providing all the methods defined by the <code>IModel,
22-
* IView, & IController</code> interfaces.</LI>
22+
* IView, and IController</code> interfaces.</LI>
2323
* <LI>Providing the ability to override the specific <code>Model</code>,
2424
* <code>View</code> and <code>Controller</code> Singletons created.</LI>
2525
* <LI>Providing a single point of contact to the application for
2626
* registering <code>Commands</code> and notifying <code>Observers</code></LI>
2727
* </UL>
2828
* <P>
29-
* Example usage:
29+
* Example usage:</P>
3030
* <listing>
31-
* import org.puremvc.as3.patterns.facade.&lowast;;
31+
* import org.puremvc.as3.patterns.facade.Facade;
3232
*
3333
* import com.me.myapp.model.~~;
3434
* import com.me.myapp.view.~~;
@@ -136,7 +136,7 @@ package org.puremvc.as3.patterns.facade
136136
* This <code>IFacade</code> implementation is a Singleton,
137137
* so you should not call the constructor
138138
* directly, but instead call the static Singleton
139-
* Factory method <code>Facade.getInstance()</code>
139+
* Factory method <code>Facade.getInstance()</code></P>
140140
*
141141
* @throws Error Error if Singleton instance has already been constructed
142142
*
@@ -177,15 +177,14 @@ package org.puremvc.as3.patterns.facade
177177
* <P>
178178
* Called by the <code>initializeFacade</code> method.
179179
* Override this method in your subclass of <code>Facade</code>
180-
* if one or both of the following are true:
180+
* if one or both of the following are true:</P>
181181
* <UL>
182182
* <LI> You wish to initialize a different <code>IController</code>.</LI>
183-
* <LI> You have <code>Commands</code> to register with the <code>Controller</code> at startup.</code>. </LI>
183+
* <LI> You have <code>Commands</code> to register with the <code>Controller</code> at startup. </LI>
184184
* </UL>
185185
* If you don't want to initialize a different <code>IController</code>,
186186
* call <code>super.initializeController()</code> at the beginning of your
187187
* method, then register <code>Command</code>s.
188-
* </P>
189188
*/
190189
protected function initializeController( ):void {
191190
if ( controller != null ) return;
@@ -198,11 +197,11 @@ package org.puremvc.as3.patterns.facade
198197
* <P>
199198
* Called by the <code>initializeFacade</code> method.
200199
* Override this method in your subclass of <code>Facade</code>
201-
* if one or both of the following are true:
200+
* if one or both of the following are true: </P>
202201
* <UL>
203202
* <LI> You wish to initialize a different <code>IModel</code>.</LI>
204203
* <LI> You have <code>Proxy</code>s to register with the Model that do not
205-
* retrieve a reference to the Facade at construction time.</code></LI>
204+
* retrieve a reference to the Facade at construction time.</LI>
206205
* </UL>
207206
* If you don't want to initialize a different <code>IModel</code>,
208207
* call <code>super.initializeModel()</code> at the beginning of your
@@ -227,7 +226,7 @@ package org.puremvc.as3.patterns.facade
227226
* <P>
228227
* Called by the <code>initializeFacade</code> method.
229228
* Override this method in your subclass of <code>Facade</code>
230-
* if one or both of the following are true:
229+
* if one or both of the following are true:</P>
231230
* <UL>
232231
* <LI> You wish to initialize a different <code>IView</code>.</LI>
233232
* <LI> You have <code>Observers</code> to register with the <code>View</code></LI>
@@ -377,7 +376,7 @@ package org.puremvc.as3.patterns.facade
377376
*
378377
* <P>
379378
* Keeps us from having to construct new notification
380-
* instances in our implementation code.
379+
* instances in our implementation code. </P>
381380
* @param notificationName the name of the notiification to send
382381
* @param body the body of the notification (optional)
383382
* @param type the type of the notification (optional)
@@ -393,7 +392,7 @@ package org.puremvc.as3.patterns.facade
393392
* This method is left public mostly for backward
394393
* compatibility, and to allow you to send custom
395394
* notification classes using the facade.</P>
396-
*<P>
395+
* <P>
397396
* Usually you should just call sendNotification
398397
* and pass the parameters, never having to
399398
* construct the notification yourself.</P>

src/org/puremvc/as3/patterns/observer/Notification.as

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ package org.puremvc.as3.patterns.observer
3636
* PureMVC <code>Notification</code>s follow a 'Publish/Subscribe'
3737
* pattern. PureMVC classes need not be related to each other in a
3838
* parent/child relationship in order to communicate with one another
39-
* using <code>Notification</code>s.
39+
* using <code>Notification</code>s.</P>
4040
*
4141
* @see org.puremvc.as3.patterns.observer.Observer Observer
4242
*

src/org/puremvc/as3/patterns/observer/Notifier.as

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ package org.puremvc.as3.patterns.observer
1212
*
1313
* <P>
1414
* <code>MacroCommand, Command, Mediator</code> and <code>Proxy</code>
15-
* all have a need to send <code>Notifications</code>. <P>
15+
* all have a need to send <code>Notifications</code>. </P>
1616
* <P>
1717
* The <code>INotifier</code> interface provides a common method called
1818
* <code>sendNotification</code> that relieves implementation code of
@@ -39,7 +39,7 @@ package org.puremvc.as3.patterns.observer
3939
*
4040
* <P>
4141
* Keeps us from having to construct new INotification
42-
* instances in our implementation code.
42+
* instances in our implementation code.</P>
4343
* @param notificationName the name of the notiification to send
4444
* @param body the body of the notification (optional)
4545
* @param type the type of the notification (optional)

src/org/puremvc/as3/patterns/observer/Observer.as

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ package org.puremvc.as3.patterns.observer
2121
* <LI>Encapsulate the notification context (this) of the interested object.</LI>
2222
* <LI>Provide methods for setting the notification method and context.</LI>
2323
* <LI>Provide a method for notifying the interested object.</LI>
24-
* </UL>
24+
* </UL></P>
2525
*
2626
* @see org.puremvc.as3.core.view.View View
2727
* @see org.puremvc.as3.patterns.observer.Notification Notification

0 commit comments

Comments
 (0)