From e7e4bcdeab3a552f043c15d8eea5bd12d6f3b8f0 Mon Sep 17 00:00:00 2001
From: dgelessus <dgelessus@users.noreply.github.com>
Date: Tue, 5 Jun 2018 14:59:42 +0200
Subject: [PATCH] Fix javadoc warnings
---
src/main/resources/patchfiles/IParser.txt | 2 +-
src/main/resources/patchfiles/IToken.txt | 2 +-
.../patchfiles/ITokenListContainer.txt | 4 +--
.../resources/patchfiles/PositionedNode.txt | 2 +-
.../resources/patchfiles/SourcePosition.txt | 2 +-
.../resources/patchfiles/SourcePositions.txt | 34 +++++++++----------
.../resources/patchfiles/SourcecodeRange.txt | 2 +-
7 files changed, 23 insertions(+), 25 deletions(-)
diff --git a/src/main/resources/patchfiles/IParser.txt b/src/main/resources/patchfiles/IParser.txt
index a5d25de..98d239e 100644
--- a/src/main/resources/patchfiles/IParser.txt
+++ b/src/main/resources/patchfiles/IParser.txt
@@ -1,4 +1,4 @@
-/**
+/*
* (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)
diff --git a/src/main/resources/patchfiles/IToken.txt b/src/main/resources/patchfiles/IToken.txt
index 65c0aff..b8ae5da 100644
--- a/src/main/resources/patchfiles/IToken.txt
+++ b/src/main/resources/patchfiles/IToken.txt
@@ -1,4 +1,4 @@
-/**
+/*
* (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)
diff --git a/src/main/resources/patchfiles/ITokenListContainer.txt b/src/main/resources/patchfiles/ITokenListContainer.txt
index 8d72be4..8280e1e 100644
--- a/src/main/resources/patchfiles/ITokenListContainer.txt
+++ b/src/main/resources/patchfiles/ITokenListContainer.txt
@@ -1,4 +1,4 @@
-/**
+/*
* (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)
@@ -10,4 +10,4 @@ import java.util.List;
public interface ITokenListContainer {
public List<IToken> getTokenList();
-}
\ No newline at end of file
+}
diff --git a/src/main/resources/patchfiles/PositionedNode.txt b/src/main/resources/patchfiles/PositionedNode.txt
index 7072ca6..0af0ce9 100644
--- a/src/main/resources/patchfiles/PositionedNode.txt
+++ b/src/main/resources/patchfiles/PositionedNode.txt
@@ -1,4 +1,4 @@
-/**
+/*
* (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)
diff --git a/src/main/resources/patchfiles/SourcePosition.txt b/src/main/resources/patchfiles/SourcePosition.txt
index 6521067..106966f 100644
--- a/src/main/resources/patchfiles/SourcePosition.txt
+++ b/src/main/resources/patchfiles/SourcePosition.txt
@@ -1,4 +1,4 @@
-/**
+/*
* (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)
diff --git a/src/main/resources/patchfiles/SourcePositions.txt b/src/main/resources/patchfiles/SourcePositions.txt
index eefe61e..a13acd0 100644
--- a/src/main/resources/patchfiles/SourcePositions.txt
+++ b/src/main/resources/patchfiles/SourcePositions.txt
@@ -1,4 +1,4 @@
-/**
+/*
* (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 < 0</code> the index <code>0</code> is returned. If
- * <code>line >= 1 && column < 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();
diff --git a/src/main/resources/patchfiles/SourcecodeRange.txt b/src/main/resources/patchfiles/SourcecodeRange.txt
index 629befb..e064a45 100644
--- a/src/main/resources/patchfiles/SourcecodeRange.txt
+++ b/src/main/resources/patchfiles/SourcecodeRange.txt
@@ -1,4 +1,4 @@
-/**
+/*
* (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)
--
GitLab