From c70cf22d39f9abbe0c0e2a42be4faed2ae75621c Mon Sep 17 00:00:00 2001
From: Ruslan Diachenko <rd.ryly@gmail.com>
Date: Sat, 29 Aug 2015 22:27:43 +0100
Subject: [PATCH] Issue #1566: 'missing javadoc comment' violations fixed in
 ParseTreeModel, TreeTableModelAdapter

---
 .../tools/checkstyle/gui/ParseTreeModel.java  | 12 +++++++++++
 .../checkstyle/gui/TreeTableModelAdapter.java | 21 ++++++++++++++-----
 2 files changed, 28 insertions(+), 5 deletions(-)

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeModel.java b/src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeModel.java
index 5603a9160..9b3000972 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeModel.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeModel.java
@@ -34,21 +34,33 @@ import com.puppycrawl.tools.checkstyle.utils.TokenUtils;
  * @author Lars Kühne
  */
 public class ParseTreeModel extends AbstractTreeTableModel {
+    /** Column names. */
     private static final String[] COLUMN_NAMES = {
         "Tree", "Type", "Line", "Column", "Text",
     };
 
+    /**
+     * @param parseTree DetailAST parse tree.
+     */
     public ParseTreeModel(DetailAST parseTree) {
         super(createArtificialTreeRoot());
         setParseTree(parseTree);
     }
 
+    /**
+     * Creates artificial tree root.
+     * @return Artificial tree root.
+     */
     private static DetailAST createArtificialTreeRoot() {
         final ASTFactory factory = new ASTFactory();
         factory.setASTNodeClass(DetailAST.class.getName());
         return (DetailAST) factory.create(TokenTypes.EOF, "ROOT");
     }
 
+    /**
+     * Sets parse tree.
+     * @param parseTree DetailAST parse tree.
+     */
     final void setParseTree(DetailAST parseTree) {
         final DetailAST root = (DetailAST) getRoot();
         root.setFirstChild(parseTree);
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTableModelAdapter.java b/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTableModelAdapter.java
index 38535b2f5..e36c13590 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTableModelAdapter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTableModelAdapter.java
@@ -45,9 +45,15 @@ public class TreeTableModelAdapter extends AbstractTableModel {
     /** For Serialisation that will never happen. */
     private static final long serialVersionUID = 8269213416115369275L;
 
+    /** JTree component. */
     private final JTree tree;
+    /** Tree table model. */
     private final transient TreeTableModel treeTableModel;
 
+    /**
+     * @param treeTableModel Tree table model.
+     * @param tree JTree component.
+     */
     public TreeTableModelAdapter(TreeTableModel treeTableModel, JTree tree) {
         this.tree = tree;
         this.treeTableModel = treeTableModel;
@@ -83,11 +89,6 @@ public class TreeTableModelAdapter extends AbstractTableModel {
         return tree.getRowCount();
     }
 
-    private Object nodeForRow(int row) {
-        final TreePath treePath = tree.getPathForRow(row);
-        return treePath.getLastPathComponent();
-    }
-
     @Override
     public Object getValueAt(int row, int column) {
         return treeTableModel.getValueAt(nodeForRow(row), column);
@@ -98,6 +99,16 @@ public class TreeTableModelAdapter extends AbstractTableModel {
         return treeTableModel.isCellEditable(column);
     }
 
+    /**
+     * Finds node for a given row.
+     * @param row Row for which to find a related node.
+     * @return Node for a given row.
+     */
+    private Object nodeForRow(int row) {
+        final TreePath treePath = tree.getPathForRow(row);
+        return treePath.getLastPathComponent();
+    }
+
     /**
      * Invokes fireTableDataChanged after all the pending events have been
      * processed. SwingUtilities.invokeLater is used to handle this.