[mod_cluster-issues] [JBoss JIRA] (MODCLUSTER-643) Misleading javadoc for SPI Container Engine
Radoslav Husar (JIRA)
issues at jboss.org
Wed Feb 28 11:11:00 EST 2018
[ https://issues.jboss.org/browse/MODCLUSTER-643?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13539723#comment-13539723 ]
Radoslav Husar commented on MODCLUSTER-643:
-------------------------------------------
Thanks for the report, agreed, looks like a paste problem, the whole sentence (The connector to which this engine uses to communicate with its proxies.) does not even make sense.
> Misleading javadoc for SPI Container Engine
> -------------------------------------------
>
> Key: MODCLUSTER-643
> URL: https://issues.jboss.org/browse/MODCLUSTER-643
> Project: mod_cluster
> Issue Type: Bug
> Reporter: Michal Herda
> Assignee: Radoslav Husar
>
> https://github.com/modcluster/mod_cluster/blob/7e4dadf03df78f05bbf06af6985ccf70d439f06a/container/spi/src/main/java/org/jboss/modcluster/container/Engine.java#L60
> {code}
> /**
> * The connector to which this engine uses to communicate with its proxies.
> *
> * @return the connector used by mod_cluster
> */
> Connector getProxyConnector();
> /**
> * The connector to which this engine uses to communicate with its proxies.
> *
> * @return the connector used by mod_cluster
> */
> Iterable<Connector> getConnectors();
> {code}
> From what I see and understand from the code, the javadoc for getConnectors() does not reflect its actual purpose - it seems like a copypaste from getProxyConnector(). I am not competent enough to write a proper JavaDoc myself through - please support me with it.
--
This message was sent by Atlassian JIRA
(v7.5.0#75005)
More information about the mod_cluster-issues
mailing list