Author: jmesnil
Date: 2009-12-09 08:57:51 -0500 (Wed, 09 Dec 2009)
New Revision: 8639
Modified:
trunk/src/main/org/hornetq/core/buffers/package-info.java
trunk/src/main/org/hornetq/core/client/ClientConsumer.java
trunk/src/main/org/hornetq/core/client/ClientRequestor.java
trunk/src/main/org/hornetq/core/client/ClientSessionFactory.java
Log:
HORNETQ-186: fill in Javadocs for core API
* break javadoc paragraphs
Modified: trunk/src/main/org/hornetq/core/buffers/package-info.java
===================================================================
--- trunk/src/main/org/hornetq/core/buffers/package-info.java 2009-12-09 13:30:12 UTC (rev
8638)
+++ trunk/src/main/org/hornetq/core/buffers/package-info.java 2009-12-09 13:57:51 UTC (rev
8639)
@@ -13,10 +13,10 @@
/**
* HornetQ Buffering.
- *
+ * <br>
* This package defines the buffers used by HornetQ. The underlying implementations uses
* Netty's ChannelBuffer and wraps it with methods required by HornetQ usage.
- *
+ * <br>
* ChannelBuffer differs from {@link java.nio.ByteBuffer} in two ways:
* <ol>
* <li>it is possible to interface almost directly with byte arrays, what is
faster</li>
Modified: trunk/src/main/org/hornetq/core/client/ClientConsumer.java
===================================================================
--- trunk/src/main/org/hornetq/core/client/ClientConsumer.java 2009-12-09 13:30:12 UTC
(rev 8638)
+++ trunk/src/main/org/hornetq/core/client/ClientConsumer.java 2009-12-09 13:57:51 UTC
(rev 8639)
@@ -17,11 +17,11 @@
/**
* A ClientConsumer receives messages from HornetQ queues.
- *
+ * <br>
* Messages can be consumed synchronously by using the <code>receive()</code>
methods
* which will block until a message is received (or a timeout expires) or asynchronously
* by setting a {@link MessageHandler}.
- *
+ * <br>
* These 2 types of consumption are exclusive: a ClientConsumer with a MessageHandler set
will
* throw HornetQException if its <code>receive()</code> methods are called.
*
Modified: trunk/src/main/org/hornetq/core/client/ClientRequestor.java
===================================================================
--- trunk/src/main/org/hornetq/core/client/ClientRequestor.java 2009-12-09 13:30:12 UTC
(rev 8638)
+++ trunk/src/main/org/hornetq/core/client/ClientRequestor.java 2009-12-09 13:57:51 UTC
(rev 8639)
@@ -19,7 +19,7 @@
/**
* The ClientRequestor class helps making requests.
- *
+ * <br>
* The ClientRequestor constructor is given a ClientSession and a request address.
* It creates a temporary queue for the responses and provides a request method that
sends the request message and waits for its reply.
*
Modified: trunk/src/main/org/hornetq/core/client/ClientSessionFactory.java
===================================================================
--- trunk/src/main/org/hornetq/core/client/ClientSessionFactory.java 2009-12-09 13:30:12
UTC (rev 8638)
+++ trunk/src/main/org/hornetq/core/client/ClientSessionFactory.java 2009-12-09 13:57:51
UTC (rev 8639)
@@ -22,7 +22,7 @@
/**
* A ClientSessionFactory is the entry point to create and configure HornetQ resources to
produce and consume messages.
- *
+ * <br>
* It is possible to configure a factory using the setter methods only if no session has
been created.
* Once a session is created, the configuration is fixed and any call to a setter method
will throw a IllegalStateException.
*
Show replies by date