Polish Javadoc for @JmsListener

Author: sbrannen

spring-jms/src/main/java/org/springframework/jms/annotation/JmsListener.java

@@ -26,44 +26,45 @@
 
 /**
  * Annotation that marks a method to be the target of a JMS message
- * listener on the specified {@link #destination()}. The {@link #containerFactory()}
+ * listener on the specified {@link #destination}. The {@link #containerFactory}
  * identifies the {@link org.springframework.jms.config.JmsListenerContainerFactory
- * JmsListenerContainerFactory} to use to build the jms listener container. If not
+ * JmsListenerContainerFactory} to use to build the JMS listener container. If not
  * set, a <em>default</em> container factory is assumed to be available with a bean
  * name of {@code jmsListenerContainerFactory} unless an explicit default has been
  * provided through configuration.
  *
  * <p>Processing of {@code @JmsListener} annotations is performed by
  * registering a {@link JmsListenerAnnotationBeanPostProcessor}. This can be
  * done manually or, more conveniently, through the {@code <jms:annotation-driven/>}
- * element or {@link EnableJms} annotation.
+ * element or {@link EnableJms @EnableJms} annotation.
  *
  * <p>Annotated methods are allowed to have flexible signatures similar to what
- * {@link MessageMapping} provides, that is
+ * {@link MessageMapping} provides:
  * <ul>
  * <li>{@link javax.jms.Session} to get access to the JMS session</li>
- * <li>{@link javax.jms.Message} or one if subclass to get access to the raw JMS message</li>
- * <li>{@link org.springframework.messaging.Message} to use the messaging abstraction counterpart</li>
+ * <li>{@link javax.jms.Message} or one of its subclasses to get access to the raw JMS message</li>
+ * <li>{@link org.springframework.messaging.Message} to use Spring's messaging abstraction counterpart</li>
  * <li>{@link org.springframework.messaging.handler.annotation.Payload @Payload}-annotated method
- * arguments including the support of validation</li>
+ * arguments, including support for validation</li>
  * <li>{@link org.springframework.messaging.handler.annotation.Header @Header}-annotated method
- * arguments to extract a specific header value, including standard JMS headers defined by
+ * arguments to extract specific header values, including standard JMS headers defined by
  * {@link org.springframework.jms.support.JmsHeaders JmsHeaders}</li>
  * <li>{@link org.springframework.messaging.handler.annotation.Headers @Headers}-annotated
- * argument that must also be assignable to {@link java.util.Map} for getting access to all
- * headers.</li>
+ * method argument that must also be assignable to {@link java.util.Map} for obtaining access to all
+ * headers</li>
  * <li>{@link org.springframework.messaging.MessageHeaders MessageHeaders} arguments for
- * getting access to all headers.</li>
+ * obtaining access to all headers</li>
  * <li>{@link org.springframework.messaging.support.MessageHeaderAccessor MessageHeaderAccessor}
  * or {@link org.springframework.jms.support.JmsMessageHeaderAccessor JmsMessageHeaderAccessor}
- * for convenient access to all method arguments.</li>
+ * for convenient access to all method arguments</li>
  * </ul>
  *
- * <p>Annotated method may have a non {@code void} return type. When they do, the result of the
- * method invocation is sent as a JMS reply to the destination defined by either the
- * {@code JMSReplyTO} header of the incoming message. When this value is not set, a default
- * destination can be provided by adding @{@link org.springframework.messaging.handler.annotation.SendTo
- * SendTo} to the method declaration.
+ * <p>Annotated methods may have a non-{@code void} return type. When they do,
+ * the result of the method invocation is sent as a JMS reply to the destination
+ * defined by the {@code JMSReplyTO} header of the incoming message. If this header
+ * is not set, a default destination can be provided by adding
+ * {@link org.springframework.messaging.handler.annotation.SendTo @SendTo} to the
+ * method declaration.
  *
  * @author Stephane Nicoll
  * @since 4.1
@@ -78,21 +79,22 @@
 
 	/**
 	 * The unique identifier of the container managing this endpoint.
-	 * <p>if none is specified an auto-generated one is provided.
+	 * <p>If none is specified, an auto-generated one is provided.
 	 * @see org.springframework.jms.config.JmsListenerEndpointRegistry#getListenerContainer(String)
 	 */
 	String id() default "";
 
 	/**
-	 * The bean name of the {@link org.springframework.jms.config.JmsListenerContainerFactory}
-	 * to use to create the message listener container responsible to serve this endpoint.
+	 * The bean name of the {@link org.springframework.jms.config.JmsListenerContainerFactory JmsListenerContainerFactory}
+	 * to use to create the message listener container responsible for serving this endpoint.
 	 * <p>If not specified, the default container factory is used, if any.
 	 */
 	String containerFactory() default "";
 
 	/**
 	 * The destination name for this listener, resolved through the container-wide
-	 * {@link org.springframework.jms.support.destination.DestinationResolver} strategy.
+	 * {@link org.springframework.jms.support.destination.DestinationResolver DestinationResolver}
+	 * strategy.
 	 */
 	String destination();
 
@@ -102,17 +104,19 @@
 	String subscription() default "";
 
 	/**
-	 * The JMS message selector expression, if any
+	 * The JMS message selector expression, if any.
 	 * <p>See the JMS specification for a detailed definition of selector expressions.
 	 */
 	String selector() default "";
 
 	/**
-	 * The concurrency for the listener, if any.
-	 * <p>The concurrency limits can be a "lower-upper" String, e.g. "5-10", or a simple
-	 * upper limit String, e.g. "10" (the lower limit will be 1 in this case).
-	 * <p>The underlying container may or may not support all features. For instance, it
-	 * may not be able to scale: in that case only the upper value is used.
+	 * The concurrency limits for the listener, if any.
+	 * <p>The concurrency limits can be a "lower-upper" String &mdash; for example,
+	 * "5-10" &mdash; or a simple upper limit String &mdash; for example, "10", in
+	 * which case the lower limit will be 1.
+	 * <p>Note that the underlying container may or may not support all features.
+	 * For instance, it may not be able to scale, in which case only the upper limit
+	 * is used.
 	 */
 	String concurrency() default "";