Add RegionByLineImpl javadoc

This commit is contained in:
gonzalo
2017-10-21 19:16:38 -03:00
parent 00ce16c177
commit 00ed0a1eab

View File

@ -5,7 +5,7 @@
package net.sourceforge.pmd.lang.ast; 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 { public class RegionByLineImpl implements RegionByLine {
private int beginLine; private int beginLine;
@ -14,11 +14,11 @@ public class RegionByLineImpl implements RegionByLine {
private int endColumn; private int endColumn;
/** /**
* * Create an immutable instance with all the corresponding fields. Every field requires to be non-negative
* @param beginLine * @param beginLine the line where the region begins
* @param endLine * @param endLine the line where the region ends
* @param beginColumn * @param beginColumn the column offset from the start of the begin line where the region begins
* @param endColumn * @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) { public RegionByLineImpl(final int beginLine, final int endLine, final int beginColumn, final int endColumn) {
setBeginLine(beginLine); setBeginLine(beginLine);