This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-graph.git
The following commit(s) were added to refs/heads/master by this push:
new 71915ca Javadoc: Empty Javadoc line before the 1st tag.
71915ca is described below
commit 71915ca4724e125a868d6b4cf78cc544ad3e0c4e
Author: Gary Gregory <[email protected]>
AuthorDate: Wed Dec 31 17:45:07 2025 -0500
Javadoc: Empty Javadoc line before the 1st tag.
---
src/main/java/org/apache/commons/graph/Mapper.java | 1 +
src/main/java/org/apache/commons/graph/SynchronizedDirectedGraph.java | 1 +
src/main/java/org/apache/commons/graph/SynchronizedGraph.java | 1 +
src/main/java/org/apache/commons/graph/SynchronizedMutableGraph.java | 1 +
.../java/org/apache/commons/graph/SynchronizedUndirectedGraph.java | 1 +
.../java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java | 1 +
.../org/apache/commons/graph/coloring/NotEnoughColorsException.java | 1 +
.../commons/graph/connectivity/ConnectivityAlgorithmsSelector.java | 1 +
.../apache/commons/graph/connectivity/DefaultConnectivityBuilder.java | 1 +
.../java/org/apache/commons/graph/elo/DefaultRankingSelector.java | 1 +
src/main/java/org/apache/commons/graph/elo/PlayersRank.java | 2 ++
src/main/java/org/apache/commons/graph/elo/RankingSelector.java | 1 +
.../java/org/apache/commons/graph/export/DefaultExportSelector.java | 1 +
.../apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java | 1 +
src/main/java/org/apache/commons/graph/flow/FlowNetworkHandler.java | 1 +
src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java | 1 +
src/main/java/org/apache/commons/graph/model/BaseGraph.java | 1 +
src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java | 4 ++++
src/main/java/org/apache/commons/graph/model/InMemoryPath.java | 1 +
.../org/apache/commons/graph/scc/CheriyanMehlhornGabowAlgorithm.java | 1 +
.../java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java | 1 +
src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java | 4 ++++
src/main/java/org/apache/commons/graph/weight/Monoid.java | 1 +
23 files changed, 30 insertions(+)
diff --git a/src/main/java/org/apache/commons/graph/Mapper.java
b/src/main/java/org/apache/commons/graph/Mapper.java
index e5903f0..7fadb21 100644
--- a/src/main/java/org/apache/commons/graph/Mapper.java
+++ b/src/main/java/org/apache/commons/graph/Mapper.java
@@ -33,6 +33,7 @@ public interface Mapper<I, O>
/**
* TODO Fill the java doc
+ *
* @param input
* @return
*/
diff --git
a/src/main/java/org/apache/commons/graph/SynchronizedDirectedGraph.java
b/src/main/java/org/apache/commons/graph/SynchronizedDirectedGraph.java
index 2ede733..97fc303 100644
--- a/src/main/java/org/apache/commons/graph/SynchronizedDirectedGraph.java
+++ b/src/main/java/org/apache/commons/graph/SynchronizedDirectedGraph.java
@@ -33,6 +33,7 @@ final class SynchronizedDirectedGraph<V, E>
/**
* Creates a new thread-safe instence of {@link SynchronizedDirectedGraph}.
+ *
* @param g The {@link Graph} that has to be synchronized
*/
public SynchronizedDirectedGraph( DirectedGraph<V, E> g )
diff --git a/src/main/java/org/apache/commons/graph/SynchronizedGraph.java
b/src/main/java/org/apache/commons/graph/SynchronizedGraph.java
index c037c85..b16a3f6 100644
--- a/src/main/java/org/apache/commons/graph/SynchronizedGraph.java
+++ b/src/main/java/org/apache/commons/graph/SynchronizedGraph.java
@@ -36,6 +36,7 @@ class SynchronizedGraph<V, E>
/**
* Creates a new thread-safe instence of {@link SynchronizedGraph}.
+ *
* @param g The {@link Graph} that has to be synchronized
*/
public SynchronizedGraph( Graph<V, E> g )
diff --git
a/src/main/java/org/apache/commons/graph/SynchronizedMutableGraph.java
b/src/main/java/org/apache/commons/graph/SynchronizedMutableGraph.java
index 12f1c7c..f4bd366 100644
--- a/src/main/java/org/apache/commons/graph/SynchronizedMutableGraph.java
+++ b/src/main/java/org/apache/commons/graph/SynchronizedMutableGraph.java
@@ -33,6 +33,7 @@ final class SynchronizedMutableGraph<V, E>
/**
* Creates a new thread-safe instence of {@link SynchronizedMutableGraph}.
+ *
* @param g The {@link Graph} that has to be synchronized
*/
public SynchronizedMutableGraph( MutableGraph<V, E> g )
diff --git
a/src/main/java/org/apache/commons/graph/SynchronizedUndirectedGraph.java
b/src/main/java/org/apache/commons/graph/SynchronizedUndirectedGraph.java
index 2e8c3fd..77fb97a 100644
--- a/src/main/java/org/apache/commons/graph/SynchronizedUndirectedGraph.java
+++ b/src/main/java/org/apache/commons/graph/SynchronizedUndirectedGraph.java
@@ -31,6 +31,7 @@ final class SynchronizedUndirectedGraph<V, E>
/**
* Creates a new thread-safe instence of {@link
SynchronizedUndirectedGraph}.
+ *
* @param g The {@link Graph} that has to be synchronized
*/
public SynchronizedUndirectedGraph( Graph<V, E> g )
diff --git
a/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
b/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
index 0d1a7c2..f121703 100644
--- a/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
+++ b/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
@@ -39,6 +39,7 @@ public final class DefaultColorsBuilder<V, E>
/**
* Creates a new instance of {@link DefaultColorsBuilder} for the input
graph.
+ *
* @param graph the graph
*/
public DefaultColorsBuilder( UndirectedGraph<V, E> graph )
diff --git
a/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
b/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
index 99c6d25..bd91635 100644
---
a/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
+++
b/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
@@ -38,6 +38,7 @@ public class NotEnoughColorsException
/**
* Creates new instance of {@link NotEnoughColorsException}.
+ *
* @param colors the set of color.
*/
public NotEnoughColorsException( Set<?> colors )
diff --git
a/src/main/java/org/apache/commons/graph/connectivity/ConnectivityAlgorithmsSelector.java
b/src/main/java/org/apache/commons/graph/connectivity/ConnectivityAlgorithmsSelector.java
index 892a8ac..7bb50d8 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/ConnectivityAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/ConnectivityAlgorithmsSelector.java
@@ -24,6 +24,7 @@ import java.util.List;
/**
* Builder for selecting the connectivity algorithm to perform.
+ *
* @param <V> the Graph vertices type
* @param <E> the Graph edges type
*/
diff --git
a/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
b/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
index 73fc57d..864ac76 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
@@ -38,6 +38,7 @@ public class DefaultConnectivityBuilder<V, E>
/**
* Creates a nw instance of {@link DefaultConnectivityBuilder}
+ *
* @param graph the graph
*/
public DefaultConnectivityBuilder( Graph<V, E> graph )
diff --git
a/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
b/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
index 3647524..4cdac03 100644
--- a/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
+++ b/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
@@ -36,6 +36,7 @@ public final class DefaultRankingSelector<P>
/**
* Creates a new instance of {@link DefaultRankingSelector} for gived
graph.
+ *
* @param tournamentGraph the graph
*/
public DefaultRankingSelector( DirectedGraph<P, GameResult>
tournamentGraph )
diff --git a/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
b/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
index 8990f2c..75f69bd 100644
--- a/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
+++ b/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
@@ -29,6 +29,7 @@ public interface PlayersRank<P>
/**
* Returns the ranking for the player
+ *
* @param player the player
* @return Returns the ranking for the player
*/
@@ -36,6 +37,7 @@ public interface PlayersRank<P>
/**
* Update the ranking for the player
+ *
* @param player the player
* @param ranking the ranking value
*/
diff --git a/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
b/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
index 3d8ed68..5db17cf 100644
--- a/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
+++ b/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
@@ -21,6 +21,7 @@ package org.apache.commons.graph.elo;
/**
* Ranking selector
+ *
* @param <P> the player's type
*/
public interface RankingSelector<P>
diff --git
a/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
b/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
index 0e8e3db..6e0eaf1 100644
--- a/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
+++ b/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
@@ -39,6 +39,7 @@ public final class DefaultExportSelector<V, E>
/**
* Creates a new instance of export selector for the given graph
+ *
* @param graph the graph
*/
public DefaultExportSelector( Graph<V, E> graph )
diff --git
a/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
b/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
index 4620e40..31987ea 100644
---
a/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
+++
b/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
@@ -38,6 +38,7 @@ public final class DefaultFlowWeightedEdgesBuilder<V, WE>
/**
* Creates a new instance of flow weighted edges builder for the given
graph
+ *
* @param graph the graph
*/
public DefaultFlowWeightedEdgesBuilder( DirectedGraph<V, WE> graph )
diff --git
a/src/main/java/org/apache/commons/graph/flow/FlowNetworkHandler.java
b/src/main/java/org/apache/commons/graph/flow/FlowNetworkHandler.java
index c116714..1d46b27 100644
--- a/src/main/java/org/apache/commons/graph/flow/FlowNetworkHandler.java
+++ b/src/main/java/org/apache/commons/graph/flow/FlowNetworkHandler.java
@@ -135,6 +135,7 @@ final class FlowNetworkHandler<V, E, W>
/**
* Checks whether there is an augmenting path in the flow network,
* given the current residual capacities.
+ *
* @return true if there is an augmenting path, false otherwise
*/
boolean hasAugmentingPath()
diff --git a/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
b/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
index d29ef1f..4979ee0 100644
--- a/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
+++ b/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
@@ -31,6 +31,7 @@ public interface FromHeadBuilder<V, WE, W>
/**
* TODO Fill me !!!
+ *
* @param head
* @return
*/
diff --git a/src/main/java/org/apache/commons/graph/model/BaseGraph.java
b/src/main/java/org/apache/commons/graph/model/BaseGraph.java
index 706c3c6..f610d55 100644
--- a/src/main/java/org/apache/commons/graph/model/BaseGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/BaseGraph.java
@@ -131,6 +131,7 @@ public abstract class BaseGraph<V, E>
/**
* Return the edge {@link Set}
+ *
* @return the edge {@link Set}
*/
protected Set<E> getAllEdges()
diff --git a/src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java
b/src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java
index 581781e..57074e4 100644
--- a/src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java
@@ -73,6 +73,7 @@ public abstract class BaseMutableGraph<V, E>
/**
* Executes additional actions to edge that will be added
+ *
* @param head the head vertex
* @param e the edge
* @param tail the tail vertex
@@ -81,18 +82,21 @@ public abstract class BaseMutableGraph<V, E>
/**
* Executes additional actions to vertex that will be added
+ *
* @param v the vertex
*/
protected abstract void decorateAddVertex( V v );
/**
* Executes additional actions to edge that will be removed
+ *
* @param e the edge
*/
protected abstract void decorateRemoveEdge( E e );
/**
* Executes additional actions to vertex that will be removed
+ *
* @param v the vertex
*/
protected abstract void decorateRemoveVertex( V v );
diff --git a/src/main/java/org/apache/commons/graph/model/InMemoryPath.java
b/src/main/java/org/apache/commons/graph/model/InMemoryPath.java
index 5a8982e..db5faf5 100644
--- a/src/main/java/org/apache/commons/graph/model/InMemoryPath.java
+++ b/src/main/java/org/apache/commons/graph/model/InMemoryPath.java
@@ -64,6 +64,7 @@ public class InMemoryPath<V, E>
/**
* Creates a new instance of {@link InMemoryPath} from {@code start}
vertex to {@code taget} vertex
+ *
* @param start the start vertex.
* @param target the target vertex.
*/
diff --git
a/src/main/java/org/apache/commons/graph/scc/CheriyanMehlhornGabowAlgorithm.java
b/src/main/java/org/apache/commons/graph/scc/CheriyanMehlhornGabowAlgorithm.java
index e054fb8..8f39cab 100644
---
a/src/main/java/org/apache/commons/graph/scc/CheriyanMehlhornGabowAlgorithm.java
+++
b/src/main/java/org/apache/commons/graph/scc/CheriyanMehlhornGabowAlgorithm.java
@@ -31,6 +31,7 @@ import org.apache.commons.graph.DirectedGraph;
/**
* Applies the classical Cheriyan/Mehlhorn/Gabow's algorithm to find the
strongly connected components, if exist.
+ *
* @param <V> the Graph vertices type.
* @param <E> the Graph edges type.
* @param <G> the directed graph type
diff --git
a/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
b/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
index ff97900..3c2aaa9 100644
--- a/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
+++ b/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
@@ -166,6 +166,7 @@ final class KosarajuSharirAlgorithm<V, E>
* <p><b>Implementation Note:</b> in the first step we look for vertices
that have not
* been visited yet, while in the second step we search for vertices that
have already
* been visited.</p>
+ *
* @param g the graph to be search
* @param source the start vertex
* @param coll the recursive collection of visited vertices
diff --git
a/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
b/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
index 399e448..b2d5b3b 100644
--- a/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
+++ b/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
@@ -36,6 +36,7 @@ public interface GraphVisitHandler<V, E, G extends Graph<V,
E>, O>
* <li>{@link VisitState.SKIP} continues the visit skipping the input
edge;</li>
* <li>{@link VisitState.ABORT} terminates the visit.</li>
* </ul>
+ *
* @return the state of the visit after operations on the edge
*/
VisitState discoverEdge( V head, E edge, V tail );
@@ -53,6 +54,7 @@ public interface GraphVisitHandler<V, E, G extends Graph<V,
E>, O>
* <li>{@link VisitState.SKIP} continues the visit skipping the input
vertex;</li>
* <li>{@link VisitState.ABORT} terminates the visit.</li>
* </ul>
+ *
* @return the state of the visit after operations on the vertex
*/
VisitState discoverVertex( V vertex );
@@ -60,6 +62,7 @@ public interface GraphVisitHandler<V, E, G extends Graph<V,
E>, O>
/**
* Checks if the search algorithm should be terminated. Called after the
search algorithm has finished
* visiting the input edge.
+ *
* @return {@link VisitState.ABORT} if the search algorithm should be
terminated after visiting the input edge, {@link VisitState.CONTINUE} otherwise
*/
VisitState finishEdge( V head, E edge, V tail );
@@ -72,6 +75,7 @@ public interface GraphVisitHandler<V, E, G extends Graph<V,
E>, O>
/**
* Checks if the search algorithm should be terminated. Called after the
search algorithm has finished
* visiting the input vertex.
+ *
* @return {@link VisitState.ABORT} if the search algorithm should be
terminated after visiting the input vertex, {@link VisitState.CONTINUE}
otherwise
*/
VisitState finishVertex( V vertex );
diff --git a/src/main/java/org/apache/commons/graph/weight/Monoid.java
b/src/main/java/org/apache/commons/graph/weight/Monoid.java
index bc4cd3a..d4e6cd3 100644
--- a/src/main/java/org/apache/commons/graph/weight/Monoid.java
+++ b/src/main/java/org/apache/commons/graph/weight/Monoid.java
@@ -49,6 +49,7 @@ public interface Monoid<E>
/**
* Returns the inverse of the input element.
+ *
* @param element the input element
* @return the inverse of the input element
*/
