[
https://issues.apache.org/jira/browse/YARN-5581?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15451600#comment-15451600
]
Varun Saxena commented on YARN-5581:
------------------------------------
IIRC, the Javadoc addition became necessary as there were a bunch of javadoc
errors coming when we ran javadoc for Java 8. Java8 javadoc asks for param
definition of each parameter in a method. It was a concious effort to have 0
javadoc errors and almost 0 checkstyle errors when we drop onto trunk.
Is there a way to define javadoc for a method by not defining each param and
linking it to the other API doc and still not get these errors ? If there is, I
agree this should be done.
> [Atsv2] Reuse the API doc for a same funtionality methods in
> TimelineReaderWebServices class
> --------------------------------------------------------------------------------------------
>
> Key: YARN-5581
> URL: https://issues.apache.org/jira/browse/YARN-5581
> Project: Hadoop YARN
> Issue Type: Improvement
> Reporter: Rohith Sharma K S
> Assignee: Rohith Sharma K S
> Labels: maintenance
>
> The class TimelineReaderWebServices has more API doc than actual code in it.
> For example : querying an app support paths.
> In TimelineReaderWebServices, basically 2 methods need to expose. Both API
> has full set of API doc. It can be optimized with additional param and give a
> link to existing API doc.
> {noformat}
> GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow
> name}/apps
> or
> GET /ws/v2/timeline/users/{user name}/flows/{flow name}/apps
> {noformat}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: yarn-issues-h...@hadoop.apache.org
