Claus Ibsen created ARTEMIS-2393:
------------------------------------

             Summary: Add javadoc for client apis such as 
ActiveMQConnectionFactory
                 Key: ARTEMIS-2393
                 URL: https://issues.apache.org/jira/browse/ARTEMIS-2393
             Project: ActiveMQ Artemis
          Issue Type: Improvement
            Reporter: Claus Ibsen


When using the client JMS api for Artemis, then you need to setup a connection 
factory such as ActiveMQConnectionFactory.

This class has a number of options (eg getter/setter) that are not documented 
in javadoc. You have to hunt it down, and you can find a little bit in 
ServerLocator etc.

But what would be good is to add proper javadoc on the class itself, that is 
what the end users of Artemis are using. This allows us to better know what all 
these options do.

For example at Apache Camel we allow users to use Artemis via camel-jms, and 
with some tooling we have (also for Camel K) then it would be nice to have 
documentation for them.

There is a screenshot at this link showing the Camel tooling with a list of 
possible options you can configure on Artemis, but we don't have any javadoc so 
our tooling cannot better document what they do
https://issues.apache.org/jira/secure/attachment/12972411/Screenshot%202019-06-21%20at%2010.27.30.png





--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to