Fix missing javadoc parameters, throw tags,...

This commit is contained in:
Jindra Petřík
2024-08-08 22:00:27 +02:00
parent cf06781fdf
commit acc5f94889
179 changed files with 1021 additions and 1477 deletions

View File

@@ -286,7 +286,7 @@ public class DottedChain implements Serializable, Comparable<DottedChain> {
* Gets the sub-chain of specific length.
*
* @param count Length
* @return
* @return Sub-chain
*/
public DottedChain subChain(int count) {
if (count > parts.size()) {
@@ -599,11 +599,6 @@ public class DottedChain implements Serializable, Comparable<DottedChain> {
this.namespaceSuffix = namespaceSuffix;
}
/**
* Hash code.
*
* @return
*/
@Override
public int hashCode() {
int hash = 5;
@@ -613,12 +608,6 @@ public class DottedChain implements Serializable, Comparable<DottedChain> {
return hash;
}
/**
* Equals.
*
* @param obj Object
* @return Whether this object is equal to the given object
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {

View File

@@ -1515,7 +1515,7 @@ public class Graph {
/**
* Expands gotos.
*
* @param list
* @param list List of GraphTargetItems
*/
private void expandGotos(List<GraphTargetItem> list) {
if (!list.isEmpty() && (list.get(list.size() - 1) instanceof GotoItem)) {

View File

@@ -141,7 +141,7 @@ public class GraphPart implements Serializable {
* @param throwStates Throw states
* @param useThrow Use throw
* @return True if this part leads to the other part
* @throws InterruptedException
* @throws InterruptedException On interrupt
*/
private boolean leadsTo(BaseLocalData localData, Graph gr, GraphSource code, GraphPart prev, GraphPart part, HashSet<GraphPart> visited, List<Loop> loops, List<ThrowState> throwStates, boolean useThrow) throws InterruptedException {
if (Thread.currentThread().isInterrupted()) {
@@ -223,7 +223,7 @@ public class GraphPart implements Serializable {
* @param throwStates Throw states
* @param useThrow Use throw
* @return True if this part leads to the other part
* @throws InterruptedException
* @throws InterruptedException On interrupt
*/
public boolean leadsTo(BaseLocalData localData, Graph gr, GraphSource code, GraphPart part, List<Loop> loops, List<ThrowState> throwStates, boolean useThrow) throws InterruptedException {
for (Loop l : loops) {

View File

@@ -41,7 +41,7 @@ public class GraphPartMarkedArrayList<E> extends ArrayList<E> {
/**
* Constructs GraphPartMarkedArrayList from another collection.
*
* @param collection
* @param collection Collection
*/
@SuppressWarnings("unchecked")
public GraphPartMarkedArrayList(Collection<? extends E> collection) {
@@ -117,8 +117,8 @@ public class GraphPartMarkedArrayList<E> extends ArrayList<E> {
/**
* Gets the index of the part in the list.
*
* @param part
* @return
* @param part Part
* @return Index of the part in the list
*/
public int indexOfPart(GraphPart part) {
for (int i = 0; i < listParts.size(); i++) {

View File

@@ -32,7 +32,7 @@ public class GraphPartQueue extends LinkedList<GraphPart> {
* Constructs a GraphPartQueue containing the elements of the specified
* collection.
*
* @param c
* @param c Collection
*/
public GraphPartQueue(Collection<? extends GraphPart> c) {
super(c);

View File

@@ -79,7 +79,7 @@ public class GraphPath implements Serializable {
/**
* Checks whether the path starts with the given path.
*
* @param p
* @param p Path
* @return True if the path starts with the given path, false otherwise
*/
public boolean startsWith(GraphPath p) {
@@ -105,7 +105,7 @@ public class GraphPath implements Serializable {
* Returns a new parent GraphPath with the given length.
*
* @param len Length
* @return
* @return New parent GraphPath
*/
public GraphPath parent(int len) {
GraphPath par = new GraphPath(rootName);
@@ -169,11 +169,6 @@ public class GraphPath implements Serializable {
return branchIps.get(index);
}
/**
* Hash code.
*
* @return Hash code
*/
@Override
public int hashCode() {
int hash = 5;
@@ -183,12 +178,6 @@ public class GraphPath implements Serializable {
return hash;
}
/**
* Equals.
*
* @param obj Eq
* @return
*/
@Override
public boolean equals(Object obj) {
if (obj == null) {

View File

@@ -47,7 +47,7 @@ public class MarkItem extends GraphTargetItem {
*
* @param writer Writer
* @param localData Local data
* @return
* @return Writer
*/
@Override
public GraphTextWriter appendTo(GraphTextWriter writer, LocalData localData) {
@@ -57,7 +57,7 @@ public class MarkItem extends GraphTargetItem {
/**
* Gets the mark string.
*
* @return
* @return Mark string
*/
public String getMark() {
return mark;

View File

@@ -74,7 +74,7 @@ public class NotCompileTimeItem extends GraphTargetItem {
* @param writer Writer
* @param localData Local data
* @return Writer
* @throws InterruptedException
* @throws InterruptedException On interrupt
*/
@Override
public GraphTextWriter appendTo(GraphTextWriter writer, LocalData localData) throws InterruptedException {

View File

@@ -86,7 +86,7 @@ public class TypeFunctionItem extends GraphTargetItem {
* @param writer Writer
* @param localData Local data
* @return Writer
* @throws InterruptedException
* @throws InterruptedException On interrupt
*/
@Override
public GraphTextWriter appendTo(GraphTextWriter writer, LocalData localData) throws InterruptedException {

View File

@@ -156,7 +156,7 @@ public class TypeItem extends GraphTargetItem {
* @param writer Writer
* @param localData Local data
* @return Writer
* @throws InterruptedException
* @throws InterruptedException On interrupt
*/
@Override
public GraphTextWriter appendTo(GraphTextWriter writer, LocalData localData) throws InterruptedException {
@@ -207,7 +207,7 @@ public class TypeItem extends GraphTargetItem {
* @param localData Local data
* @param generator Source generator
* @return List of graph source items
* @throws CompilationException
* @throws CompilationException On compilation error
*/
@Override
public List<GraphSourceItem> toSource(SourceGeneratorLocalData localData, SourceGenerator generator) throws CompilationException {