Merge pull request #4128 from markknol/patch-1

Remoting class documentation

std/haxe/remoting/AMFConnection.hx

@@ -21,6 +21,9 @@
  */
 package haxe.remoting;
 
+/**
+	Allows a connection to an AMF Remoting server such as Flash Media Server or AMFPHP.
+*/
 class AMFConnection implements AsyncConnection implements Dynamic<AsyncConnection> {
 
 	var __data : {

std/haxe/remoting/AsyncConnection.hx

@@ -21,6 +21,9 @@
  */
 package haxe.remoting;
 
+/**
+	For asynchronous connections, where the results are events that will be resolved later in the execution process.
+*/
 interface AsyncConnection implements Dynamic<AsyncConnection> {
 
 	function resolve( name : String ) : AsyncConnection;

std/haxe/remoting/Context.hx

@@ -21,6 +21,9 @@
  */
 package haxe.remoting;
 
+/**
+    Allows communication between platforms. This is a shared API that can be called on the connection at the client code.
+*/
 class Context {
 
 	var objects : haxe.ds.StringMap<{ obj : Dynamic, rec : Bool }>;
@@ -58,4 +61,4 @@ class Context {
 		return ctx;
 	}
 
-}
+}

std/haxe/remoting/HttpAsyncConnection.hx

@@ -21,6 +21,9 @@
  */
 package haxe.remoting;
 
+/**
+    Allows an asynchronous connection to the given URL which should link to a Haxe server application.
+*/
 class HttpAsyncConnection implements AsyncConnection implements Dynamic<AsyncConnection> {
 
 	var __data : { url : String, error : Dynamic -> Void };

std/haxe/remoting/HttpConnection.hx

@@ -21,6 +21,9 @@
  */
 package haxe.remoting;
 
+/**
+    Allows a synchronous connection to the given URL which should link to a Haxe server application.
+*/
 class HttpConnection implements Connection implements Dynamic<Connection> {
 
 	public static var TIMEOUT = 10.;

std/haxe/remoting/LocalConnection.hx

@@ -21,6 +21,9 @@
  */
 package haxe.remoting;
 
+/**
+    Allows communications to a different application that runs on the same client device
+*/
 class LocalConnection implements AsyncConnection implements Dynamic<AsyncConnection> {
 
 	static var ID = 0;

std/haxe/remoting/Proxy.hx

@@ -22,7 +22,7 @@
 package haxe.remoting;
 
 /**
-	This class is magic. When you extend it with a class C, it will automaticaly
+	When you extend it with a class C, it will automatically
 	create a stub class with all public methods forwarding remoting messages over
 	the connection.
 **/
@@ -34,4 +34,4 @@ class Proxy<T> {
 		__cnx = c;
 	}
 
-}
+}

std/haxe/remoting/SocketConnection.hx

@@ -22,6 +22,9 @@
 package haxe.remoting;
 import haxe.remoting.SocketProtocol.Socket;
 
+/**
+	Allows remoting communications over a socket connection
+*/
 class SocketConnection implements AsyncConnection implements Dynamic<AsyncConnection> {
 
 	var __path : Array<String>;