[
https://issues.apache.org/jira/browse/METRON-1834?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16665624#comment-16665624
]
ASF GitHub Bot commented on METRON-1834:
----------------------------------------
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/1242
Just chiming in here in support of taking some care around javadoc. I tend
to agree that it goes stale and it can become misleading. I think the metric
(and this is just personal opinion here) should be that any public API should
be well javadoc'd and otherwise documented (e.g. the REST API) and we should
seriously consider javadoc'ing classes which are used broadly.
I tend to prefer a compromise whereby the class itself has documentation
around the intent and use of the class in Javadoc and the methods are named
well and broken up well. From there, I'm ok if there's less effort put around
javadoc of individual methods.
Just my $0.02
> Migrate Elasticsearch from TransportClient to new Java REST API
> ---------------------------------------------------------------
>
> Key: METRON-1834
> URL: https://issues.apache.org/jira/browse/METRON-1834
> Project: Metron
> Issue Type: Improvement
> Reporter: Michael Miklavcic
> Assignee: Michael Miklavcic
> Priority: Major
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
