Skip to content
Snippets Groups Projects
Commit e7e4bcde authored by dgelessus's avatar dgelessus
Browse files

Fix javadoc warnings

parent 2907348a
No related branches found
No related tags found
No related merge requests found
/**
/*
* (c) 2009 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
* Heinrich Heine Universitaet Duesseldorf
* This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
......
/**
/*
* (c) 2009 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
* Heinrich Heine Universitaet Duesseldorf
* This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
......
/**
/*
* (c) 2009 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
* Heinrich Heine Universitaet Duesseldorf
* This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
......
/**
/*
* (c) 2009 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
* Heinrich Heine Universitaet Duesseldorf
* This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
......
/**
/*
* (c) 2009 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
* Heinrich Heine Universitaet Duesseldorf
* This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
......
/**
/*
* (c) 2009 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
* Heinrich Heine Universitaet Duesseldorf
* This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
......@@ -22,10 +22,10 @@ public class SourcePositions {
/**
* Returns the {@link SourcecodeRange} of this {@link PositionedNode} or
* <code>null</code> if no {@link SourcecodeRange} is available.
* {@code null} if no {@link SourcecodeRange} is available.
*
* @param node the node with source code information
* @return the source code range of <code>node</code>
* @return the source code range of {@code node}
*/
public SourcecodeRange getSourcecodeRange(final PositionedNode node) {
return positions.get(node);
......@@ -33,11 +33,11 @@ public class SourcePositions {
/**
* Returns the line in which this {@link PositionedNode} begins. The value
* <code>0</code> is returned if no sourcecode range is available for this
* {@code 0} is returned if no sourcecode range is available for this
* {@link PositionedNode}.
*
* @param node the node with source code information
* @return the line where the <code>node</code> starts
* @return the line where the {@code node} starts
*/
public int getBeginLine(final PositionedNode node) {
if (node instanceof IToken) {
......@@ -57,11 +57,11 @@ public class SourcePositions {
/**
* Returns the column of the first character of this {@link PositionedNode},
* i.e. the begin column. The value <code>0</code> is returned if no
* i.e. the begin column. The value {@code 0} is returned if no
* sourcecode range is available for this {@link PositionedNode}.
*
* @param node the node with source code information
* @return the begin column of <code>node</code>
* @return the begin column of {@code node}
*/
public int getBeginColumn(final PositionedNode node) {
if (node instanceof IToken) {
......@@ -81,7 +81,7 @@ public class SourcePositions {
/**
* Returns the line in which the {@link PositionedNode} ends. The value
* <code>0</code> is returned if no sourcecode range is available for this
* {@code 0} is returned if no sourcecode range is available for this
* {@link PositionedNode}.
*
* @param node the node with source code information
......@@ -125,7 +125,7 @@ public class SourcePositions {
/**
* Returns the last column of this {@link PositionedNode}, i.e. the column
* of the last character of the {@link PositionedNode}. The value
* <code>0</code> is returned if no sourcecode range is available for this
* {@code 0} is returned if no sourcecode range is available for this
* {@link PositionedNode}.
*
* @param node the node with source code information
......@@ -175,7 +175,7 @@ public class SourcePositions {
* can be determined for this {@link PositionedNode}.
*
* @param node the node with source code information
* @return all tokens of <code>node</code>
* @return all tokens of {@code node}
*/
public IToken[] getTokens(final PositionedNode node) {
if (node instanceof IToken) {
......@@ -299,9 +299,9 @@ public class SourcePositions {
* Finds the index of the token that belongs to the position.
* </p>
* <p>
* If no token list is available <code>-1</code> is returned. For
* <code>line &lt; 0</code> the index <code>0</code> is returned. If
* <code>line &gt;= 1 &amp;&amp; column &lt; 0</code> the line number is returned.
* If no token list is available {@code -1} is returned. For
* {@code line < 0} the index {@code 0} is returned. If
* {@code line >= 1 && column < 0} the line number is returned.
* </p>
* <p>
* If the line matches but the requested column is beyond the max. length of
......@@ -413,11 +413,9 @@ public class SourcePositions {
/**
* Compares the token position (within line only) with the column.
*
* @param token
* @param column
* @return <code>-1</code> if <code>column < beginColumn</code>,
* <code>1</code> if <code>endColumn < column</code> or
* <code>0</code> if the column is within the range of the token.
* @return {@code -1} if {@code column < beginColumn},
* {@code 1} if {@code endColumn < column} or
* {@code 0} if the column is within the range of the token.
*/
private int compareTokenColumn(final IToken token, final int column) {
final int beginColumn = token.getPos();
......
/**
/*
* (c) 2009 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
* Heinrich Heine Universitaet Duesseldorf
* This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment