Merged bug22913 into default

Author: Emile Joubert

src/com/rabbitmq/client/Connection.java

@@ -40,7 +40,8 @@
  *
  * <pre>
  * ConnectionFactory factory = new ConnectionFactory();
- * factory.setHostName(hostName);
+ * factory.setHost(hostName);
+ * factory.setPort(portNumber);
  * factory.setVirtualHost(virtualHost);
  * factory.setUsername(username);
  * factory.setPassword(password);

src/com/rabbitmq/client/ConnectionFactory.java

@@ -135,7 +135,8 @@ public int getPort() {
     }
 
     /**
-     *  @return the default port to use for connections
+     * Set the target port.
+     * @param port the default port to use for connections
      */
     public void setPort(int port) {
         this.port = port;
@@ -244,7 +245,7 @@ public void setRequestedHeartbeat(int requestedHeartbeat) {
      * table. Such changes will take effect when the next new
      * connection is started using this factory.
      * @return the map of client properties
-     * @see setClientProperties()
+     * @see #setClientProperties
      */
     public Map<String, Object> getClientProperties() {
         return _clientProperties;
@@ -254,7 +255,7 @@ public Map<String, Object> getClientProperties() {
      * Replace the table of client properties that will be sent to the
      * server during subsequent connection startups.
      * @param clientProperties the map of extra client properties
-     * @see getClientProperties()
+     * @see #getClientProperties
      */
     public void setClientProperties(Map<String, Object> clientProperties) {
         _clientProperties = clientProperties;

src/com/rabbitmq/client/impl/AMQConnection.java

@@ -54,17 +54,8 @@
 /**
  * Concrete class representing and managing an AMQP connection to a broker.
  * <p>
- * To connect to a broker,
- *
- * <pre>
- * AMQConnection conn = new AMQConnection(hostName, portNumber);
- * conn.open(username, portNumber, virtualHost);
- * </pre>
- *
- * <pre>
- * ChannelN ch1 = conn.createChannel(1);
- * ch1.open(&quot;&quot;);
- * </pre>
+ * To create a broker connection, use {@link ConnectionFactory}.  See {@link Connection}
+ * for an example.
  */
 public class AMQConnection extends ShutdownNotifierComponent implements Connection {
     /** Timeout used while waiting for AMQP handshaking to complete (milliseconds) */
@@ -79,7 +70,7 @@ public class AMQConnection extends ShutdownNotifierComponent implements Connecti
      * method is called when each new ConnectionFactory instance is
      * constructed.
      * @return a map of client properties
-     * @see Connection.getClientProperties()
+     * @see Connection#getClientProperties
      */
     public static Map<String, Object> defaultClientProperties() {
         return Frame.buildTable(new Object[] {
@@ -134,7 +125,7 @@ public static Map<String, Object> defaultClientProperties() {
 
     /**
      * Protected API - respond, in the driver thread, to a ShutdownSignal.
-     * @param channelNumber the number of the channel to disconnect
+     * @param channel the channel to disconnect
      */
     public final void disconnectChannel(ChannelN channel) {
         _channelManager.disconnectChannel(channel);

src/com/rabbitmq/client/impl/ChannelN.java

@@ -64,8 +64,8 @@
  * To open a channel,
  * <pre>
  * {@link Connection} conn = ...;
- * {@link ChannelN} ch1 = conn.{@link Connection#createChannel createChannel}(1);
- * ch1.{@link ChannelN#open open}("");
+ * {@link ChannelN} ch1 = conn.{@link Connection#createChannel createChannel}();
+ * ch1.{@link ChannelN#open open}();
  * </pre>
  */
 public class ChannelN extends AMQChannel implements com.rabbitmq.client.Channel {