[Asterisk-java-cvs] CVS: asterisk-java/src/java/net/sf/asterisk/manager ManagerConnection.java,1.7,1.8

[Stefan R. <sr...@us...>]

Update of /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19181/src/java/net/sf/asterisk/manager

Modified Files:
	ManagerConnection.java 
Log Message:
Added intention of this interface to the javadoc

Index: ManagerConnection.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/ManagerConnection.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -p -r1.7 -r1.8
--- ManagerConnection.java	23 Jun 2005 22:06:10 -0000	1.7
+++ ManagerConnection.java	7 Jul 2005 00:19:17 -0000	1.8
@@ -23,7 +23,14 @@ import net.sf.asterisk.manager.response.
 
 /**
  * The main interface to talk to an Asterisk server via the Asterisk Manager
- * API. A concrete implementation of this interface can be obtained from a
+ * API.<br>
+ * The ManagerConnection repesents a connection to an Asterisk Server and is
+ * capable to send Actions and receive Responses and Events. It does not add any
+ * valuable functionality but rather provides a Java view to Asterisk's Manager
+ * API (freeing you from TCP/IP connection and parsing stuff).<br>
+ * It is used as the foundation for higher leveled interfaces like the
+ * AsteriskManager.<br>
+ * A concrete implementation of this interface can be obtained from a
  * ManagerConnectionFactory.
  * 
  * @see net.sf.asterisk.manager.ManagerConnectionFactory
@@ -135,7 +142,9 @@ public interface ManagerConnection
     /**
      * Registers an event handler to be called whenever an
      * {@link net.sf.asterisk.manager.event.ManagerEvent} is receiced from the
-     * asterisk server.
+     * asterisk server.<br>
+     * Event handlers are notified about new events in the same order as they
+     * were registered via addEventHandler.
      * 
      * @param eventHandler the handler to call whenever a manager event is
      *            received