activemq-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Tully <gary.tu...@gmail.com>
Subject Re: JavaDoc
Date Tue, 07 Dec 2010 10:16:43 GMT
On setBridgeTempDestinations, your description below is correct.

On the missing javadoc, I agree that this is a problem, improving the
javadoc is an ongoing process, all contributions are most welcome.
We do try and provide meaningful attribute names, such that the
meaning is implicit.

On 7 December 2010 00:45, Brett Wooldridge <brett.wooldridge@gmail.com> wrote:
> Hi All,
>
> I'm using ActiveMQ 5.4.2 and programmatically creating a network of
> brokers.  In the process, I'm trying to make sure I'm properly configuring
> the network connections, etc. and referring to the JavaDoc to verify my
> understanding.
>
> Unfortunately, almost every class I run across in the javadoc
> ultimately has no documentation.  As a developer who contributes to
> several other projects, including Bitronix JTA and Derby which have
> very complete public JavaDoc, I might suggest setting up Checkstyle
> to (1) emit build warnings or better (2) fail builds for classes with
> undocumented public methods.
>
> Which brings me to my question.  I am creating a NetworkConnector
> from Broker A to Broker B.  When I look at the completions in my IDE
> for methods on NetworkConnector, I see:
>
> setBridgeTempDestinations(boolean bridgeTempDestinations)
>
> This method is inherited from ActiveMQTopic.  Unfortunately the
> JavaDoc for this method just says:
>
> "the bridgeTempDestinations to set"
>
> Which isn't very informative.  Can someone tell me what this does?
> Does it imply that temporary destinations are not "bridged" to other
> brokers if this is set to 'false', and are "bridged" if set to true?
>
> Brett
>



-- 
http://blog.garytully.com
http://fusesource.com

Mime
View raw message