You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2008/03/30 18:55:06 UTC

svn commit: r642772 - in /activemq/camel/trunk/components: camel-jms/src/main/java/org/apache/camel/component/jms/ camel-jms/src/main/java/org/apache/camel/component/jms/requestor/ camel-mail/src/main/java/org/apache/camel/component/mail/ camel-rmi/src...

Author: davsclaus
Date: Sun Mar 30 09:55:03 2008
New Revision: 642772

URL: http://svn.apache.org/viewvc?rev=642772&view=rev
Log:
CAMEL-404 fixed javadoc warnings (camel-jms, camel-mail, camel-rmi, camel-script)

Modified:
    activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsBinding.java
    activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
    activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsExchange.java
    activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/requestor/FailedToProcessResponse.java
    activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailBinding.java
    activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailConsumer.java
    activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailExchange.java
    activemq/camel/trunk/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiConsumer.java
    activemq/camel/trunk/components/camel-script/src/main/java/org/apache/camel/builder/script/ScriptBuilder.java

Modified: activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsBinding.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsBinding.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsBinding.java (original)
+++ activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsBinding.java Sun Mar 30 09:55:03 2008
@@ -49,7 +49,7 @@
 
 
 /**
- * A Strategy used to convert between a Camel {@JmsExchange} and {@JmsMessage}
+ * A Strategy used to convert between a Camel {@link JmsExchange} and {@link JmsMessage}
  * to and from a JMS {@link Message}
  *
  * @version $Revision$
@@ -62,8 +62,9 @@
     /**
      * Extracts the body from the JMS message
      *
-     * @param exchange
-     * @param message
+     * @param exchange the exchange
+     * @param message  the message to extract its body
+     * @return the body, can be <tt>null</tt>
      */
     public Object extractBodyFromJms(Exchange exchange, Message message) {
         try {

Modified: activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java (original)
+++ activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsConfiguration.java Sun Mar 30 09:55:03 2008
@@ -742,8 +742,8 @@
      * CACHE_CONSUMER to avoid missing messages (due to the consumer being
      * created and destroyed per message).
      *
-     * @return
-     * @param endpoint
+     * @param endpoint the endpoint
+     * @return the cacne level
      */
     protected int defaultCacheLevel(JmsEndpoint endpoint) {
         // if we are on a new enough spring version we can assume CACHE_CONSUMER

Modified: activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsExchange.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsExchange.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsExchange.java (original)
+++ activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/JmsExchange.java Sun Mar 30 09:55:03 2008
@@ -24,7 +24,7 @@
 import org.apache.camel.impl.DefaultExchange;
 
 /**
- * Represents an {@ilnk Exchange} for working with JMS messages while exposing the inbound and outbound JMS {@link Message}
+ * Represents an {@link Exchange} for working with JMS messages while exposing the inbound and outbound JMS {@link Message}
  * objects via {@link #getInMessage()} and {@link #getOutMessage()}
  *
  * @version $Revision:520964 $

Modified: activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/requestor/FailedToProcessResponse.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/requestor/FailedToProcessResponse.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/requestor/FailedToProcessResponse.java (original)
+++ activemq/camel/trunk/components/camel-jms/src/main/java/org/apache/camel/component/jms/requestor/FailedToProcessResponse.java Sun Mar 30 09:55:03 2008
@@ -36,8 +36,6 @@
 
     /**
      * The response message which caused the exception
-     *
-     * @return
      */
     public Message getResponse() {
         return response;

Modified: activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailBinding.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailBinding.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailBinding.java (original)
+++ activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailBinding.java Sun Mar 30 09:55:03 2008
@@ -30,7 +30,7 @@
 import org.apache.camel.converter.ObjectConverter;
 
 /**
- * A Strategy used to convert between a Camel {@Exchange} and {@Message} to and
+ * A Strategy used to convert between a Camel {@link Exchange} and {@link Message} to and
  * from a Mail {@link MimeMessage}
  * 
  * @version $Revision$

Modified: activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailConsumer.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailConsumer.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailConsumer.java (original)
+++ activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailConsumer.java Sun Mar 30 09:55:03 2008
@@ -29,8 +29,8 @@
 import org.apache.commons.logging.LogFactory;
 
 /**
- * A {@link Consumer} which consumes messages from JavaMail using a
- * {@link Transport} and dispatches them to the {@link Processor}
+ * A {@link org.apache.camel.Consumer Consumer} which consumes messages from JavaMail using a
+ * {@link javax.mail.Transport Transport} and dispatches them to the {@link Processor}
  * 
  * @version $Revision$
  */

Modified: activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailExchange.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailExchange.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailExchange.java (original)
+++ activemq/camel/trunk/components/camel-mail/src/main/java/org/apache/camel/component/mail/MailExchange.java Sun Mar 30 09:55:03 2008
@@ -24,7 +24,7 @@
 import org.apache.camel.impl.DefaultExchange;
 
 /**
- * Represents an {@ilnk Exchange} for working with Mail
+ * Represents an {@link Exchange} for working with Mail
  *
  * @version $Revision:520964 $
  */

Modified: activemq/camel/trunk/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiConsumer.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiConsumer.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiConsumer.java (original)
+++ activemq/camel/trunk/components/camel-rmi/src/main/java/org/apache/camel/component/rmi/RmiConsumer.java Sun Mar 30 09:55:03 2008
@@ -30,7 +30,7 @@
 import org.apache.camel.impl.DefaultConsumer;
 
 /**
- * A {@link Consumer} which uses RMI's {@see UnicastRemoteObject} to consume
+ * A {@link org.apache.camel.Consumer Consumer} which uses RMI's {@link UnicastRemoteObject} to consume
  * method invocations.
  * 
  * @version $Revision$

Modified: activemq/camel/trunk/components/camel-script/src/main/java/org/apache/camel/builder/script/ScriptBuilder.java
URL: http://svn.apache.org/viewvc/activemq/camel/trunk/components/camel-script/src/main/java/org/apache/camel/builder/script/ScriptBuilder.java?rev=642772&r1=642771&r2=642772&view=diff
==============================================================================
--- activemq/camel/trunk/components/camel-script/src/main/java/org/apache/camel/builder/script/ScriptBuilder.java (original)
+++ activemq/camel/trunk/components/camel-script/src/main/java/org/apache/camel/builder/script/ScriptBuilder.java Sun Mar 30 09:55:03 2008
@@ -125,9 +125,8 @@
     }
 
     /**
-     * Creates a script builder for the named language and script
+     * Creates a script builder for the named language and script {@link Resource}
      * 
-     * @{link Resource}
      * @param language the language to use for the script
      * @param scriptResource the resource used to load the script
      * @return the builder
@@ -137,9 +136,8 @@
     }
 
     /**
-     * Creates a script builder for the named language and script
-     * 
-     * @{link File}
+     * Creates a script builder for the named language and script {@link File}
+     *
      * @param language the language to use for the script
      * @param scriptFile the file used to load the script
      * @return the builder
@@ -149,9 +147,8 @@
     }
 
     /**
-     * Creates a script builder for the named language and script
+     * Creates a script builder for the named language and script {@link URL}
      * 
-     * @{link URL}
      * @param language the language to use for the script
      * @param scriptURL the URL used to load the script
      * @return the builder
@@ -174,9 +171,8 @@
     }
 
     /**
-     * Creates a script builder for the groovy script
-     * 
-     * @{link Resource}
+     * Creates a script builder for the groovy script {@link Resource}
+     *
      * @param scriptResource the resource used to load the script
      * @return the builder
      */
@@ -185,9 +181,8 @@
     }
 
     /**
-     * Creates a script builder for the groovy script
+     * Creates a script builder for the groovy script {@link File}
      * 
-     * @{link File}
      * @param scriptFile the file used to load the script
      * @return the builder
      */
@@ -196,9 +191,8 @@
     }
 
     /**
-     * Creates a script builder for the groovy script
+     * Creates a script builder for the groovy script {@link URL}
      * 
-     * @{link URL}
      * @param scriptURL the URL used to load the script
      * @return the builder
      */
@@ -231,9 +225,8 @@
     }
 
     /**
-     * Creates a script builder for the JavaScript/ECMAScript script
-     * 
-     * @{link File}
+     * Creates a script builder for the JavaScript/ECMAScript script {@link File}
+     *
      * @param scriptFile the file used to load the script
      * @return the builder
      */
@@ -242,9 +235,8 @@
     }
 
     /**
-     * Creates a script builder for the JavaScript/ECMAScript script
-     * 
-     * @{link URL}
+     * Creates a script builder for the JavaScript/ECMAScript script {@link URL}
+     *
      * @param scriptURL the URL used to load the script
      * @return the builder
      */
@@ -266,9 +258,8 @@
     }
 
     /**
-     * Creates a script builder for the PHP script
-     * 
-     * @{link Resource}
+     * Creates a script builder for the PHP script {@link Resource}
+     *
      * @param scriptResource the resource used to load the script
      * @return the builder
      */
@@ -277,9 +268,8 @@
     }
 
     /**
-     * Creates a script builder for the PHP script
-     * 
-     * @{link File}
+     * Creates a script builder for the PHP script {@link File}
+     *
      * @param scriptFile the file used to load the script
      * @return the builder
      */
@@ -288,9 +278,8 @@
     }
 
     /**
-     * Creates a script builder for the PHP script
-     * 
-     * @{link URL}
+     * Creates a script builder for the PHP script {@link URL}
+     *
      * @param scriptURL the URL used to load the script
      * @return the builder
      */
@@ -312,9 +301,8 @@
     }
 
     /**
-     * Creates a script builder for the Python script
-     * 
-     * @{link Resource}
+     * Creates a script builder for the Python script {@link Resource}
+     *
      * @param scriptResource the resource used to load the script
      * @return the builder
      */
@@ -323,9 +311,8 @@
     }
 
     /**
-     * Creates a script builder for the Python script
-     * 
-     * @{link File}
+     * Creates a script builder for the Python script {@link File}
+     *
      * @param scriptFile the file used to load the script
      * @return the builder
      */
@@ -334,9 +321,8 @@
     }
 
     /**
-     * Creates a script builder for the Python script
-     * 
-     * @{link URL}
+     * Creates a script builder for the Python script {@link URL}
+     *
      * @param scriptURL the URL used to load the script
      * @return the builder
      */
@@ -358,9 +344,8 @@
     }
 
     /**
-     * Creates a script builder for the Ruby/JRuby script
-     * 
-     * @{link Resource}
+     * Creates a script builder for the Ruby/JRuby script {@link Resource}
+     *
      * @param scriptResource the resource used to load the script
      * @return the builder
      */
@@ -369,9 +354,8 @@
     }
 
     /**
-     * Creates a script builder for the Ruby/JRuby script
-     * 
-     * @{link File}
+     * Creates a script builder for the Ruby/JRuby script {@link File}
+     *
      * @param scriptFile the file used to load the script
      * @return the builder
      */
@@ -380,9 +364,8 @@
     }
 
     /**
-     * Creates a script builder for the Ruby/JRuby script
+     * Creates a script builder for the Ruby/JRuby script {@link URL}
      * 
-     * @{link URL}
      * @param scriptURL the URL used to load the script
      * @return the builder
      */