[mod_cluster-issues] [JBoss JIRA] (MODCLUSTER-643) Misleading JavaDoc for SPI Container Engine

[Radoslav Husar (JIRA)]

     [ https://issues.jboss.org/browse/MODCLUSTER-643?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Radoslav Husar updated MODCLUSTER-643:
--------------------------------------
              Status: Pull Request Sent  (was: Open)
    Git Pull Request: https://github.com/modcluster/mod_cluster/pull/317


> Misleading JavaDoc for SPI Container Engine
> -------------------------------------------
>
>                 Key: MODCLUSTER-643
>                 URL: https://issues.jboss.org/browse/MODCLUSTER-643
>             Project: mod_cluster
>          Issue Type: Bug
>          Components: Core & Container Integration (Java)
>    Affects Versions: 1.3.8.Final, 1.4.0.Alpha1
>            Reporter: Michal Herda
>            Assignee: Radoslav Husar
>            Priority: Trivial
>
> 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)