From fd58bd332700e3912bfb89cf8816a3a670916109 Mon Sep 17 00:00:00 2001
From: Tom Morris <tfmorris@gmail.com>
Date: Sat, 22 Jun 2013 16:27:18 -0400
Subject: [PATCH] Move documentation to Javadoc where it's visible

---
 .../google/refine/browsing/RowVisitor.java    | 23 ++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/main/src/com/google/refine/browsing/RowVisitor.java b/main/src/com/google/refine/browsing/RowVisitor.java
index 8e6b4601a..f910188fd 100644
--- a/main/src/com/google/refine/browsing/RowVisitor.java
+++ b/main/src/com/google/refine/browsing/RowVisitor.java
@@ -41,13 +41,30 @@ import com.google.refine.model.Row;
  * particular criteria, such as facets' constraints.
  */
 public interface RowVisitor {
-    public void start(Project project); // called before any visit() call
+    
+    /**
+     * Called before any visit() call.
+     * 
+     * @param project
+     */
+    public void start(Project project);
 
+    /**
+     * @param project project
+     * @param rowIndex zero-based row index
+     * @param row row
+     * @return true to abort visitation early - no further visit calls will be made
+     */
     public boolean visit(
             Project project, 
-            int     rowIndex,   // zero-based row index 
+            int     rowIndex, 
             Row     row
     );
 
-    public void end(Project project); // called after all visit() calls
+    /**
+     * Called after all visit() calls.
+     * 
+     * @param project
+     */
+    public void end(Project project);
 }