appskeleton: fix some formatting and typos

Author: joshtynjala

puremvc-haxe-demo-feathersui-appskeleton/README.md

@@ -14,7 +14,7 @@ This project includes an [_project.xml_](https://lime.software/docs/project-file
 
 ### Prerequisites
 
-- [Install Haxe 4.0.0 or newer](https://haxe.org/download/).
+- [Install Haxe 4.0.0 or newer](https://haxe.org/download/)
 - [Install Feathers UI from Haxelib](https://feathersui.com/learn/haxe-openfl/installation/)
 
 ### Command Line

puremvc-haxe-demo-feathersui-appskeleton/src/org/puremvc/haxe/demos/feathersui/appskeleton/model/ConfigProxy.hx

@@ -43,9 +43,9 @@ class ConfigProxy extends Proxy implements IResourceProxy {
 		setData({});
 	}
 
-	/*
-	 * Load the xml file, this method is called by StartupMonitorProxy
-	 */
+	/**
+		Load the xml file, this method is called by StartupMonitorProxy
+	**/
 	public function load():Void {
 		// create a worker who will go get some data
 		// pass it a reference to this proxy so the delegate knows where to return the data
@@ -54,11 +54,11 @@ class ConfigProxy extends Proxy implements IResourceProxy {
 		delegate.load();
 	}
 
-	/*
-	 * This is called when the delegate receives a result from the service
-	 * 
-	 * @param rpcEvent
-	 */
+	/**
+		This is called when the delegate receives a result from the service
+
+		@param rpcEvent
+	**/
 	public function result(result:Xml):Void {
 		// call the helper class for parse the XML data
 		XmlResource.parse(data, result);
@@ -70,52 +70,52 @@ class ConfigProxy extends Proxy implements IResourceProxy {
 		sendNotification(ConfigProxy.LOAD_SUCCESSFUL);
 	}
 
-	/*
-	 * This is called when the delegate receives a fault from the service
-	 * 
-	 * @param rpcEvent
-	 */
+	/**
+		This is called when the delegate receives a fault from the service
+
+		@param rpcEvent
+	**/
 	public function fault(rpcEvent:Dynamic):Void {
 		// send the failed notification
 		sendNotification(ConfigProxy.LOAD_FAILED, ConfigProxy.ERROR_LOAD_FILE);
 	}
 
 	/**
-	 * Get the config value
-	 * 
-	 * @param key the key to read 
-	 * @return String the key value stored in internal object
-	 */
+		Get the config value
+
+		@param key the key to read 
+		@return String the key value stored in internal object
+	**/
 	public function getValue(key:String):String {
 		return Reflect.field(data, key.toLowerCase());
 	}
 
 	/**
-	 * Get the config numeric value 
-	 * 
-	 * @param key the key to read 
-	 * @return Number the key value stored in internal object
-	 */
+		Get the config numeric value 
+
+		@param key the key to read 
+		@return Number the key value stored in internal object
+	**/
 	public function getNumber(key:String):Float {
 		return Std.parseFloat(Reflect.field(data, key.toLowerCase()));
 	}
 
 	/**
-	 * Get the config boolean value 
-	 * 
-	 * @param key the key to read 
-	 * @return Boolean the key value stored in internal object
-	 */
+		Get the config boolean value 
+
+		@param key the key to read 
+		@return Boolean the key value stored in internal object
+	**/
 	public function getBoolean(key:String):Bool {
 		return Reflect.field(data, key.toLowerCase()) != null ? Reflect.field(data, key.toLowerCase()).toLowerCase() == "true" : false;
 	}
 
 	/**
-	 * Set the config value if isn't defined
-	 * 
-	 * @param key the key to set
-	 * @param value the value
-	 */
+		Set the config value if isn't defined
+
+		@param key the key to set
+		@param value the value
+	**/
 	public function setDefaultValue(key:String, value:Any):Void {
 		if (Reflect.field(data, key.toLowerCase()) == null) {
 			Reflect.setField(data, key.toLowerCase(), value);

puremvc-haxe-demo-feathersui-appskeleton/src/org/puremvc/haxe/demos/feathersui/appskeleton/view/ApplicationMediator.hx

@@ -44,7 +44,7 @@ class ApplicationMediator extends Mediator implements IMediator {
 		The `ApplicationMediator` constructor also registers the 
 		Mediators for the view components created by the application.
 
-		@param object the viewComponent (the ApplicationSkeleton instance in this case)
+		@param object the viewComponent (the AppSkeleton instance in this case)
 	**/
 	public function new(viewComponent:AppSkeleton) {
 		// pass the viewComponent to the superclass where
@@ -60,13 +60,13 @@ class ApplicationMediator extends Mediator implements IMediator {
 	}
 
 	/**
-	 * List all notifications this Mediator is interested in.
-	 * <P>
-	 * Automatically called by the framework when the mediator
-	 * is registered with the view.</P>
-	 * 
-	 * @return Array the list of Nofitication names
-	 */
+		List all notifications this Mediator is interested in.
+
+		Automatically called by the framework when the mediator
+		is registered with the view.
+
+		@return Array the list of Notification names
+	**/
 	override public function listNotificationInterests():Array<String> {
 		return [ApplicationFacade.VIEW_SPLASH_SCREEN, ApplicationFacade.VIEW_MAIN_SCREEN];
 	}
@@ -76,7 +76,7 @@ class ApplicationMediator extends Mediator implements IMediator {
 
 		Called by the framework when a notification is sent that
 		this mediator expressed an interest in when registered
-		(see `listNotificationInterests`.
+		(see `listNotificationInterests`).
 
 		@param INotification a notification 
 	**/

puremvc-haxe-demo-feathersui-appskeleton/src/org/puremvc/haxe/demos/feathersui/appskeleton/view/MainScreenMediator.hx

@@ -28,8 +28,8 @@ class MainScreenMediator extends Mediator implements IMediator {
 	private var localeProxy:LocaleProxy;
 
 	/**
-	 * Constructor. 
-	 */
+		Constructor. 
+	**/
 	public function new(viewComponent:MainScreen) {
 		// pass the viewComponent to the superclass where
 		// it will be stored in the inherited viewComponent property
@@ -45,23 +45,21 @@ class MainScreenMediator extends Mediator implements IMediator {
 	}
 
 	/**
-	 * Cast the viewComponent to its actual type.
-	 * 
-	 * <P>
-	 * This is a useful idiom for mediators. The
-	 * PureMVC Mediator class defines a viewComponent
-	 * property of type Object. </P>
-	 * 
-	 * <P>
-	 * Here, we cast the generic viewComponent to 
-	 * its actual type in a protected mode. This 
-	 * retains encapsulation, while allowing the instance
-	 * (and subclassed instance) access to a 
-	 * strongly typed reference with a meaningful
-	 * name.</P>
-	 * 
-	 * @return MainScreen the viewComponent cast to org.puremvc.as3.demos.flex.appskeleton.view.components.MainScreen
-	 */
+		Cast the viewComponent to its actual type.
+
+		This is a useful idiom for mediators. The
+		PureMVC Mediator class defines a viewComponent
+		property of type Object.
+
+		Here, we cast the generic viewComponent to 
+		its actual type in a protected mode. This 
+		retains encapsulation, while allowing the instance
+		(and subclassed instance) access to a 
+		strongly typed reference with a meaningful
+		name.
+
+		@return MainScreen the viewComponent cast to org.puremvc.as3.demos.flex.appskeleton.view.components.MainScreen
+	**/
 	private var mainScreen(get, never):MainScreen;
 
 	private function get_mainScreen():MainScreen {

puremvc-haxe-demo-feathersui-appskeleton/src/org/puremvc/haxe/demos/feathersui/appskeleton/view/SplashScreenMediator.hx

@@ -41,7 +41,7 @@ class SplashScreenMediator extends Mediator implements IMediator {
 		Automatically called by the framework when the mediator
 		is registered with the view.
 
-		@return Array the list of Nofitication names
+		@return Array the list of Notification names
 	**/
 	override public function listNotificationInterests():Array<String> {
 		return [
@@ -57,7 +57,7 @@ class SplashScreenMediator extends Mediator implements IMediator {
 
 		Called by the framework when a notification is sent that
 		this mediator expressed an interest in when registered
-		(see `listNotificationInterests`.</P>
+		(see `listNotificationInterests`).
 
 		@param INotification a notification 
 	**/
@@ -95,7 +95,7 @@ class SplashScreenMediator extends Mediator implements IMediator {
 		strongly typed reference with a meaningful
 		name.
 
-		@return SplashScreen the viewComponent cast to org.puremvc.as3.demos.flex.appskeleton.view.components.SplashScreen
+		@return SplashScreen the viewComponent cast to org.puremvc.haxe.demos.feathersui.appskeleton.view.components.SplashScreen
 	**/
 	private var splashScreen(get, never):SplashScreen;