svn commit: r778349 - in /camel/trunk/camel-core/src/main/java/org/apache/camel: Processor.java Producer.java

[da...@apache.org]

Author: davsclaus
Date: Mon May 25 08:25:59 2009
New Revision: 778349

URL: http://svn.apache.org/viewvc?rev=778349&view=rev
Log:
polished javadoc

Modified:
    camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java?rev=778349&r1=778348&r2=778349&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/Processor.java Mon May 25 08:25:59 2009
@@ -17,12 +17,10 @@
 package org.apache.camel;
 
 /**
- * A <a href="http://camel.apache.org/processor.html">processor</a> is
- * used to implement the 
- * <a href="http://camel.apache.org/event-driven-consumer.html">
- * Event Driven Consumer</a> and 
- * <a href="http://camel.apache.org/message-translator.html">
- * Message Translator</a> patterns and to process message exchanges.
+ * A <a href="http://camel.apache.org/processor.html">processor</a> is used to implement the
+ * <a href="http://camel.apache.org/event-driven-consumer.html"> Event Driven Consumer</a>
+ * and <a href="http://camel.apache.org/message-translator.html"> Message Translator</a>
+ * patterns and to process message exchanges.
  * 
  * @version $Revision$
  */
@@ -31,6 +29,7 @@
     /**
      * Processes the message exchange
      * 
+     * @param exchange the message exchange
      * @throws Exception if an internal processing error has occurred.
      */
     void process(Exchange exchange) throws Exception;

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java?rev=778349&r1=778348&r2=778349&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/Producer.java Mon May 25 08:25:59 2009
@@ -24,6 +24,11 @@
  */
 public interface Producer extends Processor, Service {
 
+    /**
+     * Gets the endpoint this producer sends to.
+     *
+     * @return the endpoint
+     */
     Endpoint getEndpoint();
 
     /**
@@ -36,6 +41,7 @@
     /**
      * Creates a new exchange of the given pattern to send to this endpoint
      *
+     * @param pattern the exchange pattern
      * @return a newly created exchange
      */
     Exchange createExchange(ExchangePattern pattern);
@@ -43,6 +49,9 @@
     /**
      * Creates a new exchange for communicating with this exchange using the
      * given exchange to pre-populate the values of the headers and messages
+     *
+     * @param exchange the existing exchange
+     * @return the created exchange
      */
     Exchange createExchange(Exchange exchange);
 }