From 00ed0a1eabb01116755ed16d37f24f09db34fdf2 Mon Sep 17 00:00:00 2001
From: gonzalo <gibarsin@itba.edu.ar>
Date: Sat, 21 Oct 2017 19:16:38 -0300
Subject: [PATCH] Add RegionByLineImpl javadoc

---
 .../sourceforge/pmd/lang/ast/RegionByLineImpl.java   | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/RegionByLineImpl.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/RegionByLineImpl.java
index 79435a42f5..190b8be540 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/RegionByLineImpl.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/RegionByLineImpl.java
@@ -5,7 +5,7 @@
 package net.sourceforge.pmd.lang.ast;
 
 /**
- * Default implementation for the RegionByLine interface which is used by {@link GenericToken}
+ * Default immutable implementation for the RegionByLine interface which is used by {@link GenericToken}
  */
 public class RegionByLineImpl implements RegionByLine {
     private int beginLine;
@@ -14,11 +14,11 @@ public class RegionByLineImpl implements RegionByLine {
     private int endColumn;
 
     /**
-     *
-     * @param beginLine
-     * @param endLine
-     * @param beginColumn
-     * @param endColumn
+     * Create an immutable instance with all the corresponding fields. Every field requires to be non-negative
+     * @param beginLine the line where the region begins
+     * @param endLine the line where the region ends
+     * @param beginColumn the column offset from the start of the begin line where the region begins
+     * @param endColumn the column offset from the start of the end line where the region ends
      */
     public RegionByLineImpl(final int beginLine, final int endLine, final int beginColumn, final int endColumn) {
         setBeginLine(beginLine);