FlxG: onMobile docs + formatting (#1904)

Also removed the unnecessary @:isVar.
HaxeFlixel · Aug 21, 2016 · 81967ad · 81967ad
1 parent 778891b
commit 81967ad
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/flixel/FlxG.hx b/flixel/FlxG.hx
@@ -117,7 +117,11 @@ class FlxG
 	 */
 	public static var drawFramerate(default, set):Int;
 
-	@:isVar
+	/**
+	 * Whether the game is running on a mobile device.
+	 * If on HTML5, it returns `FlxG.html5.onMobile`.
+	 * Otherwise, it checks whether the `mobile` haxedef is defined.
+	 */
 	public static var onMobile(get, never):Bool;
 
 	public static var renderMethod(default, null):FlxRenderMethod;
@@ -713,7 +717,14 @@ class FlxG
 
 	private static inline function get_onMobile():Bool
 	{
-		return #if js html5.onMobile #elseif mobile true #else false #end;
+		return
+			#if js
+				html5.onMobile
+			#elseif mobile
+				true
+			#else
+				false
+			#end;
 	}
 }
 

diff --git a/flixel/system/frontEnds/HTML5FrontEnd.hx b/flixel/system/frontEnds/HTML5FrontEnd.hx
@@ -92,14 +92,13 @@ class HTML5FrontEnd
 
 	private function getOnMobile():Bool 
 	{
-		return
-		switch (platform)
+		return switch (platform)
 		{
 			case ANDROID, BLACKBERRY, WINDOWS_PHONE, IOS(_):
 				true;
 			default:
 				false;
-		};
+		}
 	}
 
 	private function userAgentContains(substring:String, toLowerCase:Bool = false)