From c69adf52c978cf62b4aa88f36ab6e1da85d2770b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Georg=20Gra=C3=9Fnick?= <georg.grassnick@mailbox.tu-dresden.de> Date: Tue, 30 Jul 2019 15:07:55 +0200 Subject: [PATCH] Fix Javadoc --- .../inf/mci/brailleplot/csvparser/CsvDotParser.java | 4 ++-- .../mci/brailleplot/csvparser/CsvParseAlgorithm.java | 12 ++++++------ .../datacontainers/SimplePointListContainerImpl.java | 2 +- .../inf/mci/brailleplot/point/Point2DDouble.java | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/csvparser/CsvDotParser.java b/src/main/java/de/tudresden/inf/mci/brailleplot/csvparser/CsvDotParser.java index 3fa1472a..351d4667 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/csvparser/CsvDotParser.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/csvparser/CsvDotParser.java @@ -22,7 +22,7 @@ public class CsvDotParser extends CsvParseAlgorithm { * Parses scattered point data in horizontal data sets, alternating mX and mY. The * first column contains the row mName in the mX row. * @param csvData The parsed input String. - * @return A {@link PointListContainer<PointList>} representing the data. + * @return A {@link PointListContainer}{@literal <}{@link PointList}{@literal >} representing the data. */ public PointListContainer<PointList> parseAsHorizontalDataSets(final List<? extends List<String>> csvData) { Objects.requireNonNull(csvData); @@ -76,7 +76,7 @@ public class CsvDotParser extends CsvParseAlgorithm { * Parses scattered point data in vertical data sets, alternating mX and mY. The * first row contains the column mName in the mX column. * @param csvData The parsed input String. - * @return A {@link PointListContainer<PointList>} representing the data. + * @return A {@link PointListContainer}{@literal <}{@link PointList}{@literal >} representing the data. */ @Override public PointListContainer<PointList> parseAsVerticalDataSets(final List<? extends List<String>> csvData) { diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/csvparser/CsvParseAlgorithm.java b/src/main/java/de/tudresden/inf/mci/brailleplot/csvparser/CsvParseAlgorithm.java index 2737cea7..8089d799 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/csvparser/CsvParseAlgorithm.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/csvparser/CsvParseAlgorithm.java @@ -19,25 +19,25 @@ public abstract class CsvParseAlgorithm { /** * If the data sets are oriented horizontally, i.e. in rows, parse the rows into - * {@link @link PointListContainer<PointList>}. + * {@link PointListContainer}{@literal <}{@link PointList}{@literal >}. * @param csvData The parsed input String. - * @return A {@link PointListContainer<PointList>} representing the data. + * @return A {@link PointListContainer}{@literal <PointList>} representing the data. */ public abstract PointListContainer<PointList> parseAsHorizontalDataSets(List<? extends List<String>> csvData); /** * If the data sets are oriented horizontally, i.e. in rows, parse the rows into - * {@link @link PointListContainer<PointList>}. + * {@link PointListContainer}{@literal <}{@link PointList}{@literal >}. * @param csvData The parsed input String. - * @return A {@link PointListContainer<PointList>} representing the data. + * @return A {@link PointListContainer}{@literal <}{@link PointList}{@literal >} representing the data. */ public abstract PointListContainer<PointList> parseAsVerticalDataSets(List<? extends List<String>> csvData); /** - * Adds a {@link Point2DDouble} to a {@link PointList} in a {@link PointListContainer<PointList>}, + * Adds a {@link Point2DDouble} to a {@link PointList} in a {@link PointListContainer}{@literal <}{@link PointList}{@literal >}, * specified by {@code listIndex}. Adds more {@link PointList PointLists} if * needed. - * @param container The {@link PointListContainer<PointList>} to which the point shall be added + * @param container The {@link PointListContainer}{@literal <}{@link PointList}{@literal >} to which the point shall be added * @param index The index of the list to which the point shall be added * @param point The {@link Point2DDouble} which shall be added */ diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/datacontainers/SimplePointListContainerImpl.java b/src/main/java/de/tudresden/inf/mci/brailleplot/datacontainers/SimplePointListContainerImpl.java index 0702fa9a..028c5c19 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/datacontainers/SimplePointListContainerImpl.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/datacontainers/SimplePointListContainerImpl.java @@ -5,7 +5,7 @@ import java.util.List; import java.util.Objects; /** - * A low effort implementation of {@link PointListContainer<PointList>}. + * A low effort implementation of {@link PointListContainer}{@literal <}{@link PointList}{@literal >}. * @author Georg Graßnick * @version 2019.07.29 */ diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/point/Point2DDouble.java b/src/main/java/de/tudresden/inf/mci/brailleplot/point/Point2DDouble.java index c3f019a3..6d3cb3e9 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/point/Point2DDouble.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/point/Point2DDouble.java @@ -1,7 +1,7 @@ package de.tudresden.inf.mci.brailleplot.point; /** - * An instance of a {@link Point2D<Double>}. + * An instance of a {@link Point2D}{@literal <}{@link Double}{@literal >}. * @author Georg Graßnick * @version 2019.07.29 */ -- GitLab