[jira] [Commented] (ARTEMIS-2393) Add javadoc for client apis such as ActiveMQConnectionFactory

["Justin Bertram (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARTEMIS-2393?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16869507#comment-16869507 ] 

Justin Bertram commented on ARTEMIS-2393:
-----------------------------------------

I think the proper way to handle this would be to use {{@see}} (or {{@link}}) for all the methods which {{ActiveMQConnectionFactory}} wraps from {{ServerLocator}}. I don't think just copying the actual documentation from one to the other would be good practice. However, I'm not sure this will help your tooling unless it's smart enough to deal with these tags. Can you shed any light on this?

Also, calling the various setters on {{ActiveMQConnectionFactory}} is a bit legacy at this point. The recommended option would be to specify the parameters in the URL (as done in ActiveMQ 5.x).

I had a look at the ActiveMQ 5.x {{ActiveMQConnectionFactory}} and noticed it doesn't have similar getters/setters. How then is documentation handled for the 5.x JMS client?

> 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
>            Priority: Major
>
> 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)