Incorrect documentation (JavaDoc) on PoolOptions.setName()

[Brada-Groep]

The documentation (JavaDoc) on public PoolOptions setName(String) in PoolOptions.java is as follows:

Set the pool name, used when the pool shared, otherwise ignored.
@param name the new name
@return a reference to this, so the API can be used fluently

However, it is not ignored. When you give the PoolOptions the same name as another PoolOptions, they become one (or at least something like that).

Why is this is a problem

Because it said that it was ignored when not shared, I put a generic name on my instances.
However, after one Verticle saturated all the connections inside the pool, my entire API froze. And it took me more than a full day to discover what the problem was.

Proposal

What I think the documentation should look like:

Set the pool name, used when the pool is shared. When multiple PoolOptions instances have the same name, they are merged.
@param name the new name
@return a reference to this, so the API can be used fluently

If the documentation was like this from the beginning, it would've saved me a lot of time. I hope this can be picked up!

[vietj]

I think the first pool options is used an there is no merge