[jira] [Issue Comment Deleted] (REEF-519) Add missing Javadoc comments/triage TODO notes in Java code

["Mariia Mykhailova (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/REEF-519?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Mariia Mykhailova updated REEF-519:
-----------------------------------
    Comment: was deleted

(was: [~johnyangk], please help triage TODOs introduced in
c908a52 John Yang on 1/11/2015 at 11:15 PM (committed by Markus Weimer on 1/22/2015 at 1:00 PM)
[REEF-30] Adding reef-runtime-mesos

{noformat}
org/apache/reef/runtime/mesos/client/MesosJobSubmissionHandler.java
TODO: run the driver on a slave node in the cluster
{noformat}

{noformat}
org/apache/reef/runtime/mesos/driver/MesosResourceLaunchHandler.java
TODO: Replace REEFExecutor with a simple launch command (we only need to launch REEFExecutor)
{noformat}

{noformat}
org/apache/reef/runtime/mesos/util/MesosErrorHandler.java
org/apache/reef/runtime/mesos/util/MesosRemoteManager.java
TODO: Replace this class once Tang's namespace feature is enabled
{noformat}

{noformat}
org/apache/reef/runtime/mesos/evaluator/REEFExecutor.java
TODO: a hack to pass closeEvaluator test, replace this with a better interface
{noformat}
(paired with matching TODO in REEFScheduler)

{noformat}
org/apache/reef/runtime/mesos/driver/REEFScheduler.java
private static final int MESOS_SLAVE_PORT = 5051;
//  Assumes for now that all slaves use port 5051(default) TODO: make it configurable.

.setUser("") // TODO: make it configurable.

TODO: reflect priority and rack/node locality specified in resourceRequestEvent.
{noformat}
)

> Add missing Javadoc comments/triage TODO notes in Java code
> -----------------------------------------------------------
>
>                 Key: REEF-519
>                 URL: https://issues.apache.org/jira/browse/REEF-519
>             Project: REEF
>          Issue Type: Task
>          Components: All
>            Reporter: Mariia Mykhailova
>            Priority: Minor
>
> Two major checkstyle issues left in our code are missing Javadoc comments and TODO comments.
> We need to 
> 1. Add missing Javadoc comments (including the ones marked as TODO Document)
> 2. Triage TODO comments and either remove them (if the intended action has already been done or is outdated) or find/create JIRAs for them and add links to the JIRAs to the code, so that we have a better way of tracking them.
> The format of TODO comments after triage is {noformat}TODO[JIRA REEF-JIRA_ISSUE_NUMBER]{noformat} (or they can be removed at all if JIRA has sufficient information)
> The details of what needs to be done should be put in JIRA
> How to get the list of things to be documented/triaged per module:
> 1. run mvn checkstyle:checkstyle in .\lang\java\<module>
> 2. checkstyle results will be at .\lang\java\<module>\target\site\checkstyle.html (for Tang and Wake they are in corresponding sub-projects, for example, reef-tang\tang\target\site\checkstyle.html)
> 3. JavadocType violations correspond to missing Javadoc comments
> 4. Warning-level TodoComment violations are TODOs that need to be triaged, info-level are TODOs that are already triaged (as a reminder)
> Once all existing violations are fixed, JavadocType and TodoComment for TODOs not followed with JIRA number will be converted to build breaks to prevent new violations creeping in. To convert them to build breaks in an individual project for each sub-task, update {{pom.xml}} with an individual checkstyle configuration of that project as shown in PR https://github.com/apache/incubator-reef/pull/372/ 
> Sub-tasks of this JIRA will track progress per module.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)