Commit efdb0440 authored by Lukas Jelonek's avatar Lukas Jelonek
Browse files

Corrected javadoc errors reported by jdk8

parent 5731231a
......@@ -23,17 +23,17 @@ import java.util.Objects;
/**
* Given a global interval coordinate system that is assembled from multiple subsequent smaller 'local' interval
* coordinates, this algorithm calculates the subsets of the 'local' coordinates that are needed to assemble a
* subinterval in the 'global' coordinate system. <br />
* <br />
* subinterval in the 'global' coordinate system. <br>
* <br>
* The input is a list of members, where each member defines some id, e.g. a string identifier or the real local
* instance that is part of the global coordinate system, and a length. The output is a list of memberresults where each
* result reflects the identifier from the input and the 'local' portion of the interval that has to be extracted from
* the local interval in order to assemble one part of the global interval. <br />
* <br />
* Examples usages: <br />
* - extract a subsequence from an scaffold that is constructed from multiple contigs and gaps.<br />
* the local interval in order to assemble one part of the global interval. <br>
* <br>
* Examples usages: <br>
* - extract a subsequence from an scaffold that is constructed from multiple contigs and gaps.<br>
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public class IdentifyIntervalsFromMemberlist {
......
......@@ -24,7 +24,7 @@ import java.util.List;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public class IntegerIntervalOperations implements IntervalOperations<Integer> {
......
......@@ -26,7 +26,7 @@ package de.cebitec.common.sequencetools.intervals;
* @param <T> The number type the interval uses.
* @see Intervals
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public interface Interval<T extends Number> {
......
......@@ -18,7 +18,7 @@ package de.cebitec.common.sequencetools.intervals;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public interface IntervalFormatter<T extends Number> {
......
......@@ -21,7 +21,7 @@ import java.util.List;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public class IntervalFormatterBuilder<T extends Number> {
......
......@@ -20,7 +20,7 @@ import java.util.List;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
class IntervalFormatterImpl<T extends Number> implements IntervalFormatter<T> {
......
......@@ -23,7 +23,7 @@ import java.util.List;
* the handling of empty intervals.
*
* @param <L> The number type the interval uses.
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public interface IntervalOperations<L extends Number> {
......
......@@ -23,7 +23,7 @@ import java.util.List;
/**
* Helper and factory class for intervals.
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public class Intervals {
......
......@@ -23,7 +23,7 @@ import javax.xml.bind.annotation.XmlRootElement;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
@XmlRootElement(name = "interval")
@XmlAccessorType(XmlAccessType.FIELD)
......
......@@ -22,7 +22,7 @@ import java.util.List;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
class CacheCheckResult {
......
......@@ -22,14 +22,14 @@ import de.cebitec.common.sequencetools.intervals.Interval;
* An IntervalCache is used to avoid the loading of whole, possibly large parts of contigous sequences of data, when
* only (small) parts of them are needed at a time. An IntervalCache needs at leadst three callback methods to work. The
* fetchcallback to resolve lazily loaded parts of the sequence, a mergecallback in order to merge adjacent sequences to
* a whole sequence and an extractcallback in order to retrieve subsequences.<br/>
* a whole sequence and an extractcallback in order to retrieve subsequences.<br>
*
* Examples for sequences may be lists or strings.
*
* @see IntervalCaches
*
* @param <T> The sequencetype
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public interface IntervalCache<T> {
......
......@@ -30,7 +30,7 @@ import java.util.TreeMap;
* string parts are stored in weak references to cope with small memory footprint requirements.
*
* @param <T> The type of the cached sequences.
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
class IntervalCacheImpl<T> implements IntervalCache<T> {
......
......@@ -23,7 +23,7 @@ import static de.cebitec.common.sequencetools.intervals.Intervals.*;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
class IntervalCacheItem<T> implements Interval<Integer> {
......
......@@ -24,7 +24,7 @@ import java.util.List;
/**
* Factory for IntervalCaches
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public class IntervalCaches {
......
......@@ -27,7 +27,7 @@ import org.junit.Test;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
public class IdentifyIntervalsFromMemberlistTest {
......
......@@ -26,7 +26,7 @@ import org.junit.runners.Parameterized;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
@RunWith(Parameterized.class)
public class IntegerIntervalAdjacentOperationTest {
......
......@@ -26,7 +26,7 @@ import org.junit.runners.Parameterized;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
@RunWith(Parameterized.class)
public class IntegerIntervalBeginsWithOperationTest {
......
......@@ -26,7 +26,7 @@ import org.junit.runners.Parameterized;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
@RunWith(Parameterized.class)
public class IntegerIntervalComplementOperationTest {
......
......@@ -26,7 +26,7 @@ import org.junit.runners.Parameterized;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
@RunWith(Parameterized.class)
public class IntegerIntervalContainsOperationTest {
......
......@@ -26,7 +26,7 @@ import org.junit.runners.Parameterized;
/**
*
* @author Lukas Jelonek <ljelonek at cebitec.uni-bielefeld.de>
* @author Lukas Jelonek {@literal <ljelonek at cebitec.uni-bielefeld.de>}
*/
@RunWith(Parameterized.class)
public class IntegerIntervalDistanceOperationTest {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment