[JBoss JIRA] (MODCLUSTER-643) Misleading JavaDoc for SPI Container Engine
by Radoslav Husar (JIRA)
[ https://issues.jboss.org/browse/MODCLUSTER-643?page=com.atlassian.jira.pl... ]
Radoslav Husar updated MODCLUSTER-643:
--------------------------------------
Summary: Misleading JavaDoc for SPI Container Engine (was: Misleading javadoc for SPI Container Engine)
> 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/7e4dadf03df78f05bbf06af698...
> {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)
7 years
[JBoss JIRA] (MODCLUSTER-643) Misleading javadoc for SPI Container Engine
by Radoslav Husar (JIRA)
[ https://issues.jboss.org/browse/MODCLUSTER-643?page=com.atlassian.jira.pl... ]
Radoslav Husar updated MODCLUSTER-643:
--------------------------------------
Component/s: Core & Container Integration (Java)
> 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/7e4dadf03df78f05bbf06af698...
> {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)
7 years
[JBoss JIRA] (MODCLUSTER-643) Misleading javadoc for SPI Container Engine
by Radoslav Husar (JIRA)
[ https://issues.jboss.org/browse/MODCLUSTER-643?page=com.atlassian.jira.pl... ]
Radoslav Husar updated MODCLUSTER-643:
--------------------------------------
Affects Version/s: 1.4.0.Alpha1
1.3.8.Final
> 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/7e4dadf03df78f05bbf06af698...
> {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)
7 years
[JBoss JIRA] (MODCLUSTER-643) Misleading javadoc for SPI Container Engine
by Radoslav Husar (JIRA)
[ https://issues.jboss.org/browse/MODCLUSTER-643?page=com.atlassian.jira.pl... ]
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/7e4dadf03df78f05bbf06af698...
> {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)
7 years
[JBoss JIRA] (MODCLUSTER-643) Misleading javadoc for SPI Container Engine
by Michal Herda (JIRA)
Michal Herda created MODCLUSTER-643:
---------------------------------------
Summary: 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: Jean-Frederic Clere
https://github.com/modcluster/mod_cluster/blob/7e4dadf03df78f05bbf06af698...
{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)
7 years