[REEF-519] Add missing Javadoc comments/triage TODO notes in Java code

• Type: Task
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: All
• Assignee: Unassigned
• Reporter: Mariia Mykhailova
• Created: 29/Jul/15 19:39
• Updated: 21/Oct/15 18:42

Description

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

TODO[JIRA REEF-JIRA_ISSUE_NUMBER]

(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.

Issue Links

• contains: REEF-401 Triage TODO comments in Java code
• is duplicated by: REEF-401 Triage TODO comments in Java code

Sub-Tasks

• Add missing Javadoc comments/triage TODO notes in Java code: reef-io: Open
• Add missing Javadoc comments/triage TODO notes in Java code: reef-tang: Open
• Triage XXX|FIX notes in Java code: Open