You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ha...@apache.org on 2017/12/19 02:27:55 UTC

activemq git commit: Javadoc typo fix and cleanup

Repository: activemq
Updated Branches:
  refs/heads/activemq-5.15.x 944b8273c -> c64af87ee


Javadoc typo fix and cleanup

This mostly fixes the url1/url2 copy and paste problem. It uses a bit more readable property syntax and introduces a single sentence (plain text) summary for class Javadoc and adds some links.

Project: http://git-wip-us.apache.org/repos/asf/activemq/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq/commit/c64af87e
Tree: http://git-wip-us.apache.org/repos/asf/activemq/tree/c64af87e
Diff: http://git-wip-us.apache.org/repos/asf/activemq/diff/c64af87e

Branch: refs/heads/activemq-5.15.x
Commit: c64af87ee2318bb9ea8059c07a542a02444b8b41
Parents: 944b827
Author: Bernd <be...@eckenfels.net>
Authored: Thu Feb 16 21:16:36 2017 +0100
Committer: Hadrian Zbarcea <ha...@apache.org>
Committed: Mon Dec 18 21:19:19 2017 -0500

----------------------------------------------------------------------
 .../jndi/ActiveMQWASInitialContextFactory.java  | 25 ++++++++++----------
 1 file changed, 13 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/activemq/blob/c64af87e/activemq-client/src/main/java/org/apache/activemq/jndi/ActiveMQWASInitialContextFactory.java
----------------------------------------------------------------------
diff --git a/activemq-client/src/main/java/org/apache/activemq/jndi/ActiveMQWASInitialContextFactory.java b/activemq-client/src/main/java/org/apache/activemq/jndi/ActiveMQWASInitialContextFactory.java
index 5340ae2..20c224c 100644
--- a/activemq-client/src/main/java/org/apache/activemq/jndi/ActiveMQWASInitialContextFactory.java
+++ b/activemq-client/src/main/java/org/apache/activemq/jndi/ActiveMQWASInitialContextFactory.java
@@ -24,14 +24,15 @@ import javax.naming.Context;
 import javax.naming.NamingException;
 
 /**
- * This implementation of <CODE>InitialContextFactory</CODE> should be used
- * when ActiveMQ is used as WebSphere Generic JMS Provider. It is proved that it
- * works on WebSphere 5.1. The reason for using this class is that custom
- * property defined for Generic JMS Provider are passed to InitialContextFactory
- * only if it begins with java.naming or javax.naming prefix. Additionally
- * provider url for the JMS provider can not contain ',' character that is
- * necessary when the list of nodes is provided. So the role of this class is to
- * transform properties before passing it to <tt>ActiveMQInitialContextFactory</tt>.
+ * A InitialContextFactory for WebSphere Generic JMS Provider.
+ * <p>
+ * Works on WebSphere 5.1. The reason for using this class is that custom
+ * property defined for Generic JMS Provider are passed to {@link InitialContextFactory}
+ * only if it begins with {@code java.naming} or {@code javax.naming} prefix.
+ * Additionally provider url for the JMS provider can not contain {@code ','}
+ * character that is necessary when the list of nodes is provided. So the role
+ * of this class is to transform properties before passing it to 
+ * {@link ActiveMQInitialContextFactory}.
  */
 public class ActiveMQWASInitialContextFactory extends ActiveMQInitialContextFactory {
 
@@ -45,10 +46,10 @@ public class ActiveMQWASInitialContextFactory extends ActiveMQInitialContextFact
     /**
      * Performs following transformation of properties:
      * <ul>
-     * <li>(java.naming.queue.xxx.yyy,value)=>(queue.xxx/yyy,value)
-     * <li>(java.naming.topic.xxx.yyy,value)=>(topic.xxx/yyy,value)
-     * <li>(java.naming.connectionFactoryNames,value)=>(connectionFactoryNames,value)
-     * <li>(java.naming.provider.url,url1;url2)=>java.naming.provider.url,url1,url1)
+     * <li>(java.naming.queue.xxx.yyy=value) ->(queue.xxx/yyy=value)
+     * <li>(java.naming.topic.xxx.yyy=value) -> (topic.xxx/yyy=value)
+     * <li>(java.naming.connectionxxx=value) -> (connectionxxx=value)
+     * <li>(java.naming.provider.url=url1;url2) -> (java.naming.provider.url=url1,url2)
      * <ul>
      *
      * @param environment properties for transformation