This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 4cdb3f5 Javadoc
4cdb3f5 is described below
commit 4cdb3f587d0f22e881e84ff8021b9fad268d454a
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:50:29 2026 -0400
Javadoc
---
.../org/apache/commons/graph/CommonsGraph.java | 22 +++++++++++-----------
.../org/apache/commons/graph/DirectedGraph.java | 8 ++++----
src/main/java/org/apache/commons/graph/Graph.java | 14 +++++++-------
src/main/java/org/apache/commons/graph/Path.java | 4 ++--
.../java/org/apache/commons/graph/VertexPair.java | 4 ++--
.../java/org/apache/commons/graph/Weighted.java | 2 +-
.../graph/builder/AbstractGraphConnection.java | 4 ++--
.../commons/graph/builder/GraphConnector.java | 4 ++--
.../graph/builder/LinkedConnectionBuilder.java | 2 +-
.../commons/graph/collections/DisjointSet.java | 6 +++---
.../commons/graph/collections/DisjointSetNode.java | 4 ++--
.../graph/collections/FibonacciHeapNode.java | 12 ++++++------
.../commons/graph/coloring/ColoredVertices.java | 4 ++--
.../commons/graph/coloring/ColorsBuilder.java | 2 +-
.../graph/coloring/UncoloredOrderedVertices.java | 2 +-
.../graph/connectivity/ConnectivityBuilder.java | 4 ++--
.../org/apache/commons/graph/elo/Category.java | 4 ++--
.../commons/graph/export/NamedExportSelector.java | 2 +-
.../graph/flow/MaxFlowAlgorithmSelector.java | 4 ++--
.../org/apache/commons/graph/model/BaseGraph.java | 8 ++++----
.../commons/graph/scc/KosarajuSharirAlgorithm.java | 6 +++---
.../commons/graph/scc/SccAlgorithmSelector.java | 8 ++++----
.../apache/commons/graph/scc/TarjanAlgorithm.java | 2 +-
.../commons/graph/shortestpath/Heuristic.java | 2 +-
.../graph/shortestpath/PredecessorsList.java | 4 ++--
.../graph/shortestpath/ShortestDistances.java | 2 +-
.../commons/graph/spanning/ShortestEdges.java | 2 +-
.../spanning/SpanningTreeAlgorithmSelector.java | 6 +++---
.../graph/spanning/SpanningTreeSourceSelector.java | 6 +++---
.../apache/commons/graph/spanning/SuperVertex.java | 2 +-
.../org/apache/commons/graph/utils/Assertions.java | 2 +-
.../org/apache/commons/graph/utils/Objects.java | 2 +-
.../visit/DefaultVisitAlgorithmsSelector.java | 2 +-
.../commons/graph/visit/GraphVisitHandler.java | 4 ++--
.../graph/visit/VisitAlgorithmsSelector.java | 4 ++--
.../commons/graph/visit/VisitSourceSelector.java | 2 +-
.../org/apache/commons/graph/weight/Monoid.java | 6 +++---
.../graph/coloring/AbstractColoringTest.java | 2 +-
38 files changed, 90 insertions(+), 90 deletions(-)
diff --git a/src/main/java/org/apache/commons/graph/CommonsGraph.java
b/src/main/java/org/apache/commons/graph/CommonsGraph.java
index b1bbbf9..17ee17f 100644
--- a/src/main/java/org/apache/commons/graph/CommonsGraph.java
+++ b/src/main/java/org/apache/commons/graph/CommonsGraph.java
@@ -74,7 +74,7 @@ public final class CommonsGraph
* @param <P> The players involved in the tournament
* @param <TG> the Tournament Graph type
* @param tournamentGraph the graph representing the tournament
- * @return the builder for the functor which returns/update the players
ranking
+ * @return The builder for the functor which returns/update the players
ranking
*/
public static <P, TG extends DirectedGraph<P, GameResult>>
RankingSelector<P> eloRate( TG tournamentGraph )
{
@@ -104,7 +104,7 @@ public final class CommonsGraph
* @param <E> The Graph edges type.
* @param <G> The directed graph type
* @param graph the Graph which connected component has to be verified.
- * @return the Connectivity algorithm builder
+ * @return The Connectivity algorithm builder
*/
public static <V, E, G extends Graph<V, E>> ConnectivityBuilder<V, E>
findConnectedComponent( G graph )
{
@@ -134,7 +134,7 @@ public final class CommonsGraph
* @param <WE> the Graph edges type
* @param <G> The Graph type
* @param graph the input edge-weighted graph
- * @return the caluculated the sortest
+ * @return The caluculated the sortest
*/
public static <V, WE, G extends Graph<V, WE>> PathWeightedEdgesBuilder<V,
WE> findShortestPath( G graph )
{
@@ -149,7 +149,7 @@ public final class CommonsGraph
* @param <E> The Graph edges type.
* @param <G> The directed graph type
* @param graph the Graph which strongly connected component has to be
verified.
- * @return the SCC algoritm selector
+ * @return The SCC algoritm selector
*/
public static <V, E, G extends DirectedGraph<V, E>>
SccAlgorithmSelector<V, E> findStronglyConnectedComponent( G graph )
{
@@ -164,7 +164,7 @@ public final class CommonsGraph
* @param <WE> the Graph edges type
* @param <G> The Graph type
* @param graph the input edge-weighted graph
- * @return the caluculated minimun spanning tree
+ * @return The caluculated minimun spanning tree
*/
public static <V, WE, G extends Graph<V, WE>>
SpanningWeightedEdgeMapperBuilder<V, WE> minimumSpanningTree( G graph )
{
@@ -207,7 +207,7 @@ public final class CommonsGraph
* @param <E> The Graph edges type
* @param <G> The Graph type
* @param graph the graph has to be populated
- * @return the builder to configure vertices connection
+ * @return The builder to configure vertices connection
*/
public static <V, E, G extends MutableGraph<V, E>>
LinkedConnectionBuilder<V, E, G> populate( G graph )
{
@@ -236,7 +236,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
* @param graph the input {@link Graph}
- * @return the syncronyzed graph
+ * @return The syncronyzed graph
*/
public static <V, E> Graph<V, E> synchronize( DirectedGraph<V, E> graph )
{
@@ -265,7 +265,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
* @param graph the input {@link Graph}
- * @return the syncronyzed graph
+ * @return The syncronyzed graph
*/
public static <V, E> Graph<V, E> synchronize( Graph<V, E> graph )
{
@@ -294,7 +294,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
* @param graph the input {@link Graph}
- * @return the synchronized graph
+ * @return The synchronized graph
*/
public static <V, E> Graph<V, E> synchronize( MutableGraph<V, E> graph )
{
@@ -323,7 +323,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
* @param graph the input {@link Graph}
- * @return the syncronyzed graph
+ * @return The syncronyzed graph
*/
public static <V, E> Graph<V, E> synchronize( UndirectedGraph<V, E> graph )
{
@@ -337,7 +337,7 @@ public final class CommonsGraph
* @param <E> The Graph edges type
* @param <G> The Graph type
* @param graph the Graph instance to apply graph algorithms
- * @return the graph algorithms selector
+ * @return The graph algorithms selector
*/
public static <V, E, G extends Graph<V, E>> VisitSourceSelector<V, E, G>
visit( G graph )
{
diff --git a/src/main/java/org/apache/commons/graph/DirectedGraph.java
b/src/main/java/org/apache/commons/graph/DirectedGraph.java
index 2e9b74a..2fa844f 100644
--- a/src/main/java/org/apache/commons/graph/DirectedGraph.java
+++ b/src/main/java/org/apache/commons/graph/DirectedGraph.java
@@ -37,7 +37,7 @@ public interface DirectedGraph<V, E>
* Returns the set of edges which are inbound to the vertex.
*
* @param v the vertex which inbound vertexs have to be returned
- * @return the set of vertexs which are inbound to the vertex.
+ * @return The set of vertexs which are inbound to the vertex.
*/
Iterable<V> getInbound( V v );
@@ -45,7 +45,7 @@ public interface DirectedGraph<V, E>
* For a vertex, the number of head endpoints adjacent to a node is called
the indegree.
*
* @param v the vertex which indegree has to be returned.
- * @return the number of head endpoints adjacent to a vertex.
+ * @return The number of head endpoints adjacent to a vertex.
*/
int getInDegree( V v );
@@ -53,7 +53,7 @@ public interface DirectedGraph<V, E>
* Returns the set of vertexs which lead away from the vertex.
*
* @param v the vertex which outbound vertexs have to be returned
- * @return the set of vertexs which lead away from the vertex.
+ * @return The set of vertexs which lead away from the vertex.
*/
Iterable<V> getOutbound( V v );
@@ -61,7 +61,7 @@ public interface DirectedGraph<V, E>
* For a vertex, the number of tail endpoints adjacent to a node is called
the outdegree.
*
* @param v the vertex which indegree has to be returned.
- * @return the number of head endpoints adjacent to a vertex.
+ * @return The number of head endpoints adjacent to a vertex.
*/
int getOutDegree( V v );
diff --git a/src/main/java/org/apache/commons/graph/Graph.java
b/src/main/java/org/apache/commons/graph/Graph.java
index ed9d34d..1a790c0 100644
--- a/src/main/java/org/apache/commons/graph/Graph.java
+++ b/src/main/java/org/apache/commons/graph/Graph.java
@@ -74,7 +74,7 @@ public interface Graph<V, E>
* if an error occurs while performing that operation.
*
* @param v the vertex which degree has to be returned.
- * @return the number of edges incident to the vertex.
+ * @return The number of edges incident to the vertex.
*/
int getDegree( V v );
@@ -86,7 +86,7 @@ public interface Graph<V, E>
*
* @param source the source vertex
* @param target the target vertex
- * @return the edge with vertex source and target.
+ * @return The edge with vertex source and target.
*/
E getEdge( V source, V target );
@@ -96,7 +96,7 @@ public interface Graph<V, E>
* <b>NOTE</b>: implementors have to take in consideration throwing a
{@link GraphException}
* if an error occurs while performing that operation.
*
- * @return the total set of Edges in the graph.
+ * @return The total set of Edges in the graph.
*/
Iterable<E> getEdges();
@@ -106,7 +106,7 @@ public interface Graph<V, E>
* <b>NOTE</b>: implementors have to take in consideration throwing a
{@link GraphException}
* if an error occurs while performing that operation.
*
- * @return the <i>order</i> of a Graph (the number of Vertices);
+ * @return The <i>order</i> of a Graph (the number of Vertices);
*/
int getOrder();
@@ -116,7 +116,7 @@ public interface Graph<V, E>
* <b>NOTE</b>: implementors have to take in consideration throwing a
{@link GraphException}
* if an error occurs while performing that operation.
*
- * @return the <i>size</i> of a Graph (the number of Edges)
+ * @return The <i>size</i> of a Graph (the number of Edges)
*/
int getSize();
@@ -126,7 +126,7 @@ public interface Graph<V, E>
* <b>NOTE</b>: implementors have to take in consideration throwing a
{@link GraphException}
* if an error occurs while performing that operation.
*
- * @return the total set of Vertices in the graph.
+ * @return The total set of Vertices in the graph.
*/
Iterable<V> getVertices();
@@ -137,7 +137,7 @@ public interface Graph<V, E>
* if an error occurs while performing that operation.
*
* @param e the input edge
- * @return the set of vertex on this Edge.
+ * @return The set of vertex on this Edge.
*/
VertexPair<V> getVertices( E e );
diff --git a/src/main/java/org/apache/commons/graph/Path.java
b/src/main/java/org/apache/commons/graph/Path.java
index d92a886..002f1ce 100644
--- a/src/main/java/org/apache/commons/graph/Path.java
+++ b/src/main/java/org/apache/commons/graph/Path.java
@@ -33,14 +33,14 @@ public interface Path<V, E>
/**
* Returns the source of the path.
*
- * @return the source of the path.
+ * @return The source of the path.
*/
V getSource();
/**
* Returns the target of the path.
*
- * @return the target of the path.
+ * @return The target of the path.
*/
V getTarget();
diff --git a/src/main/java/org/apache/commons/graph/VertexPair.java
b/src/main/java/org/apache/commons/graph/VertexPair.java
index 9940567..a864f0b 100644
--- a/src/main/java/org/apache/commons/graph/VertexPair.java
+++ b/src/main/java/org/apache/commons/graph/VertexPair.java
@@ -77,7 +77,7 @@ public final class VertexPair<V>
}
/**
- * @return the source
+ * @return The source
*/
public V getHead()
{
@@ -85,7 +85,7 @@ public final class VertexPair<V>
}
/**
- * @return the target
+ * @return The target
*/
public V getTail()
{
diff --git a/src/main/java/org/apache/commons/graph/Weighted.java
b/src/main/java/org/apache/commons/graph/Weighted.java
index a62bd19..d7ff559 100644
--- a/src/main/java/org/apache/commons/graph/Weighted.java
+++ b/src/main/java/org/apache/commons/graph/Weighted.java
@@ -31,7 +31,7 @@ public interface Weighted<W>
/**
* Gets the weight of the {@code Weighted} object.
*
- * @return the weight of the {@code Weighted} object.
+ * @return The weight of the {@code Weighted} object.
*/
W getWeight();
diff --git
a/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
b/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
index 2b3403f..f2ed926 100644
---
a/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
+++
b/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
@@ -38,7 +38,7 @@ public abstract class AbstractGraphConnection<V, E>
*
* @param <A> The Graph edges type
* @param arc the edge to add.
- * @return the {@link HeadVertexConnector}
+ * @return The {@link HeadVertexConnector}
*/
protected final <A extends E> HeadVertexConnector<V, E> addEdge( A arc )
{
@@ -50,7 +50,7 @@ public abstract class AbstractGraphConnection<V, E>
*
* @param <N> The Graph vertex type
* @param node the vertex to add
- * @return the vertex added
+ * @return The vertex added
*/
protected final <N extends V> N addVertex( N node )
{
diff --git a/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
b/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
index ece543e..229f5d3 100644
--- a/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
+++ b/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
@@ -33,7 +33,7 @@ public interface GraphConnector<V, E>
*
* @param <A> The Graph edges type
* @param arc the edge to add.
- * @return the {@link HeadVertexConnector}
+ * @return The {@link HeadVertexConnector}
*/
<A extends E> HeadVertexConnector<V, E> addEdge( A arc );
@@ -42,7 +42,7 @@ public interface GraphConnector<V, E>
*
* @param <N> The Graph vertices type
* @param node the vertex to add
- * @return the vertex added
+ * @return The vertex added
*/
<N extends V> N addVertex( N node );
diff --git
a/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
b/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
index 1494092..da774f4 100644
---
a/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
+++
b/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
@@ -35,7 +35,7 @@ public interface LinkedConnectionBuilder<V, E, G extends
MutableGraph<V, E>>
* Connects the graph.
*
* @param graphConnection the {@link GraphConnection}
- * @return the {@link org.apache.commons.graph.Graph} built from the
connections.
+ * @return The {@link org.apache.commons.graph.Graph} built from the
connections.
*/
G withConnections( GraphConnection<V, E> graphConnection );
diff --git
a/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
b/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
index 9d3de0e..9a83acc 100644
--- a/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
+++ b/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
@@ -39,7 +39,7 @@ public final class DisjointSet<E>
* Performs the @code{ find} operation by applying the <i>path
compression</i>.
*
* @param node the input DisjointSet node for the @code{ find} operation
- * @return the root node of the path
+ * @return The root node of the path
*/
private DisjointSetNode<E> find( DisjointSetNode<E> node )
{
@@ -54,7 +54,7 @@ public final class DisjointSet<E>
* Performs the {@code find} operation applying the <i>path
compression</i>.
*
* @param e the element has to be find in this {@code DisjointSet} instance
- * @return the value found
+ * @return The value found
*/
public E find( E e )
{
@@ -75,7 +75,7 @@ public final class DisjointSet<E>
* if already previously set, creates a new one and push it in {@link
#disjointSets} otherwise.
*
* @param e the element which related subset has to be returned
- * @return the input element {@code DisjointSetNode}
+ * @return The input element {@code DisjointSetNode}
*/
private DisjointSetNode<E> getNode( E e )
{
diff --git
a/src/main/java/org/apache/commons/graph/collections/DisjointSetNode.java
b/src/main/java/org/apache/commons/graph/collections/DisjointSetNode.java
index 99dcbc8..8ab68eb 100644
--- a/src/main/java/org/apache/commons/graph/collections/DisjointSetNode.java
+++ b/src/main/java/org/apache/commons/graph/collections/DisjointSetNode.java
@@ -64,7 +64,7 @@ final class DisjointSetNode<E>
/**
* Returns the adapted element by this node.
*
- * @return the adapted element by this node.
+ * @return The adapted element by this node.
*/
public E getElement()
{
@@ -74,7 +74,7 @@ final class DisjointSetNode<E>
/**
* Returns the reference to the parent node, the node itself by default.
*
- * @return the reference to the parent node, the node itself by default.
+ * @return The reference to the parent node, the node itself by default.
*/
public DisjointSetNode<E> getParent()
{
diff --git
a/src/main/java/org/apache/commons/graph/collections/FibonacciHeapNode.java
b/src/main/java/org/apache/commons/graph/collections/FibonacciHeapNode.java
index 7f6dd3c..091b7e2 100644
--- a/src/main/java/org/apache/commons/graph/collections/FibonacciHeapNode.java
+++ b/src/main/java/org/apache/commons/graph/collections/FibonacciHeapNode.java
@@ -100,7 +100,7 @@ final class FibonacciHeapNode<E>
/**
* Returns the reference to the first child node.
*
- * @return the reference to the first child node.
+ * @return The reference to the first child node.
*/
public FibonacciHeapNode<E> getChild()
{
@@ -110,7 +110,7 @@ final class FibonacciHeapNode<E>
/**
* Returns the number of children in the child list of node {@code x} is
stored in {@code degree[x]}.
*
- * @return the number of children in the child list of node {@code x} is
stored in {@code degree[x]}.
+ * @return The number of children in the child list of node {@code x} is
stored in {@code degree[x]}.
*/
public int getDegree()
{
@@ -120,7 +120,7 @@ final class FibonacciHeapNode<E>
/**
* Returns the adapted element by this node.
*
- * @return the adapted element by this node.
+ * @return The adapted element by this node.
*/
public E getElement()
{
@@ -130,7 +130,7 @@ final class FibonacciHeapNode<E>
/**
* Returns the left node reference.
*
- * @return the left node reference.
+ * @return The left node reference.
*/
public FibonacciHeapNode<E> getLeft()
{
@@ -140,7 +140,7 @@ final class FibonacciHeapNode<E>
/**
* Returns the reference to the parent node, if any.
*
- * @return the reference to the parent node, if any.
+ * @return The reference to the parent node, if any.
*/
public FibonacciHeapNode<E> getParent()
{
@@ -150,7 +150,7 @@ final class FibonacciHeapNode<E>
/**
* Returns the right node reference.
*
- * @return the right node reference.
+ * @return The right node reference.
*/
public FibonacciHeapNode<E> getRight()
{
diff --git
a/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
b/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
index 97f6922..fcdc336 100644
--- a/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
+++ b/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
@@ -82,7 +82,7 @@ public final class ColoredVertices<V, C>
* Returns the color associated to the input vertex.
*
* @param v the vertex for which getting the color.
- * @return the color associated to the input vertex.
+ * @return The color associated to the input vertex.
*/
public C getColor( V v )
{
@@ -94,7 +94,7 @@ public final class ColoredVertices<V, C>
/**
* Returns the number of required colors for coloring the Graph.
*
- * @return the number of required colors for coloring the Graph.
+ * @return The number of required colors for coloring the Graph.
*/
public int getRequiredColors()
{
diff --git a/src/main/java/org/apache/commons/graph/coloring/ColorsBuilder.java
b/src/main/java/org/apache/commons/graph/coloring/ColorsBuilder.java
index bdc084d..3ba3de2 100644
--- a/src/main/java/org/apache/commons/graph/coloring/ColorsBuilder.java
+++ b/src/main/java/org/apache/commons/graph/coloring/ColorsBuilder.java
@@ -35,7 +35,7 @@ public interface ColorsBuilder<V, E>
*
* @param <C> The Color type.
* @param colors the set of colors for coloring the graph.
- * @return the coloring algorithm selector.
+ * @return The coloring algorithm selector.
*/
<C> ColoringAlgorithmsSelector<V, E, C> withColors( Set<C> colors );
diff --git
a/src/main/java/org/apache/commons/graph/coloring/UncoloredOrderedVertices.java
b/src/main/java/org/apache/commons/graph/coloring/UncoloredOrderedVertices.java
index c4a8c82..feab164 100644
---
a/src/main/java/org/apache/commons/graph/coloring/UncoloredOrderedVertices.java
+++
b/src/main/java/org/apache/commons/graph/coloring/UncoloredOrderedVertices.java
@@ -112,7 +112,7 @@ final class UncoloredOrderedVertices<V>
/**
* Returns the number of vertices degrees in the graph.
*
- * @return the number of vertices degrees in the graph.
+ * @return The number of vertices degrees in the graph.
*/
public int size()
{
diff --git
a/src/main/java/org/apache/commons/graph/connectivity/ConnectivityBuilder.java
b/src/main/java/org/apache/commons/graph/connectivity/ConnectivityBuilder.java
index e113d1b..d2fd9d6 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/ConnectivityBuilder.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/ConnectivityBuilder.java
@@ -31,7 +31,7 @@ public interface ConnectivityBuilder<V, E>
/**
* Find all the connected components included into the specified graph
*
- * @return the connectivity algorithm selector.
+ * @return The connectivity algorithm selector.
*/
ConnectivityAlgorithmsSelector<V, E> includingAllVertices();
@@ -39,7 +39,7 @@ public interface ConnectivityBuilder<V, E>
* Specifies the set of vertices included into a connected component.
*
* @param vertices the set of vertices included into a connected component.
- * @return the connectivity algorithm selector.
+ * @return The connectivity algorithm selector.
*/
ConnectivityAlgorithmsSelector<V, E> includingVertices( V... vertices );
diff --git a/src/main/java/org/apache/commons/graph/elo/Category.java
b/src/main/java/org/apache/commons/graph/elo/Category.java
index 36f4673..e5682a9 100644
--- a/src/main/java/org/apache/commons/graph/elo/Category.java
+++ b/src/main/java/org/apache/commons/graph/elo/Category.java
@@ -28,14 +28,14 @@ public interface Category
/**
* Returns the category maximum points.
*
- * @return the category maximum points.
+ * @return The category maximum points.
*/
Double getMaximum();
/**
* Returns the category minimum points.
*
- * @return the category minimum points.
+ * @return The category minimum points.
*/
Double getMinimum();
diff --git
a/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
b/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
index c4bbb7c..06b0e91 100644
--- a/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
+++ b/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
@@ -33,7 +33,7 @@ public interface NamedExportSelector<V, E>
* Use the given name when exporting the {@link
org.apache.commons.graph.Graph} to a resource.
*
* @param name the name to identify the {@link
org.apache.commons.graph.Graph}
- * @return the graph export format selector
+ * @return The graph export format selector
*/
ExportSelector<V, E> withName( String name );
diff --git
a/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
b/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
index 688ac10..f321679 100644
--- a/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
+++ b/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
@@ -36,7 +36,7 @@ public interface MaxFlowAlgorithmSelector<V, WE, W>
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
- * @return the max flow calculate with Edmonds and Karp algorithm
+ * @return The max flow calculate with Edmonds and Karp algorithm
*/
<WO extends OrderedMonoid<W>> W applyingEdmondsKarp( WO weightOperations );
@@ -45,7 +45,7 @@ public interface MaxFlowAlgorithmSelector<V, WE, W>
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
- * @return the max flow calculate with Ford and Furkenson algorithm
+ * @return The max flow calculate with Ford and Furkenson algorithm
*/
<WO extends OrderedMonoid<W>> W applyingFordFulkerson( WO weightOperations
);
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 d5b7dee..92b40bd 100644
--- a/src/main/java/org/apache/commons/graph/model/BaseGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/BaseGraph.java
@@ -122,7 +122,7 @@ public abstract class BaseGraph<V, E>
/**
* Returns the adjacency list where stored vertex/edges.
*
- * @return the adjacency list where stored vertex/edges.
+ * @return The adjacency list where stored vertex/edges.
*/
protected final Map<V, Set<V>> getAdjacencyList()
{
@@ -132,7 +132,7 @@ public abstract class BaseGraph<V, E>
/**
* Return the edge {@link Set}
*
- * @return the edge {@link Set}
+ * @return The edge {@link Set}
*/
protected Set<E> getAllEdges()
{
@@ -171,7 +171,7 @@ public abstract class BaseGraph<V, E>
/**
* Returns the {@code Map} of indexed edges.
*
- * @return the {@link Map} of indexed edges
+ * @return The {@link Map} of indexed edges
*/
protected Map<VertexPair<V>, E> getIndexedEdges()
{
@@ -181,7 +181,7 @@ public abstract class BaseGraph<V, E>
/**
* Returns the {@code Map} of indexed vertices.
*
- * @return the indexed vertices {@link Map}
+ * @return The indexed vertices {@link Map}
*/
protected Map<E, VertexPair<V>> getIndexedVertices()
{
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 03dc79a..641bc04 100644
--- a/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
+++ b/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
@@ -62,7 +62,7 @@ final class KosarajuSharirAlgorithm<V, E>
*
* @param source the starting vertex
* @param visitedVertices a {@link Set} containing all visited vertices
- * @return the recursively expanded vertex list for Kosaraju's algorithm
+ * @return The recursively expanded vertex list for Kosaraju's algorithm
*/
private List<V> getExpandedVertexList( final V source, final Set<V>
visitedVertices )
{
@@ -103,7 +103,7 @@ final class KosarajuSharirAlgorithm<V, E>
/**
* Applies the classical Kosaraju's algorithm to find the strongly
connected components.
*
- * @return the input graph strongly connected component.
+ * @return The input graph strongly connected component.
*/
public Set<Set<V>> perform()
{
@@ -141,7 +141,7 @@ final class KosarajuSharirAlgorithm<V, E>
* a vertex <code>source</code>.
*
* @param source the source vertex to start the search from
- * @return the input graph strongly connected component.
+ * @return The input graph strongly connected component.
*/
public Set<V> perform( final V source )
{
diff --git
a/src/main/java/org/apache/commons/graph/scc/SccAlgorithmSelector.java
b/src/main/java/org/apache/commons/graph/scc/SccAlgorithmSelector.java
index 0e3e31d..bdefe19 100644
--- a/src/main/java/org/apache/commons/graph/scc/SccAlgorithmSelector.java
+++ b/src/main/java/org/apache/commons/graph/scc/SccAlgorithmSelector.java
@@ -33,7 +33,7 @@ public interface SccAlgorithmSelector<V, E>
/**
* Applies the classical Cheriyan/Mehlhorn/Gabow's algorithm to find the
strongly connected components, if exist.
*
- * @return the input graph strongly connected component.
+ * @return The input graph strongly connected component.
*/
Set<Set<V>> applyingCheriyanMehlhornGabow();
@@ -43,7 +43,7 @@ public interface SccAlgorithmSelector<V, E>
* <p>Note: the runtime complexity is O(V + E) and this algorithm should
be chosen
* if the number of vertices outweighs the number of edges.</p>
*
- * @return the input graph strongly connected components.
+ * @return The input graph strongly connected components.
*/
Set<Set<V>> applyingKosarajuSharir();
@@ -52,7 +52,7 @@ public interface SccAlgorithmSelector<V, E>
* a vertex <code>source</code>.
*
* @param source the source vertex to start the search from
- * @return the input graph strongly connected component.
+ * @return The input graph strongly connected component.
*/
Set<V> applyingKosarajuSharir( V source );
@@ -63,7 +63,7 @@ public interface SccAlgorithmSelector<V, E>
* <p>Note: the runtime complexity is O(V + E) and this algorithm should
be chosen
* if the number of edges outweighs the number of vertices.</p>
*
- * @return the input graph strongly connected component.
+ * @return The input graph strongly connected component.
*/
Set<Set<V>> applyingTarjan();
diff --git a/src/main/java/org/apache/commons/graph/scc/TarjanAlgorithm.java
b/src/main/java/org/apache/commons/graph/scc/TarjanAlgorithm.java
index 005a08b..5f50aef 100644
--- a/src/main/java/org/apache/commons/graph/scc/TarjanAlgorithm.java
+++ b/src/main/java/org/apache/commons/graph/scc/TarjanAlgorithm.java
@@ -104,7 +104,7 @@ final class TarjanAlgorithm<V, E>
* Tarjan's algorithm is a variation (slightly faster) on KosarajuSharir's
algorithm for finding strongly-connected
* components in a directed graph.
*
- * @return the input graph strongly connected component.
+ * @return The input graph strongly connected component.
*/
public Set<Set<V>> perform()
{
diff --git a/src/main/java/org/apache/commons/graph/shortestpath/Heuristic.java
b/src/main/java/org/apache/commons/graph/shortestpath/Heuristic.java
index 70ab90f..4a33254 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/Heuristic.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/Heuristic.java
@@ -34,7 +34,7 @@ public interface Heuristic<V, W>
*
* @param current the current visited Vertex in the Graph.
* @param goal the goal of the Graph visit.
- * @return the "heuristic estimate" of the distance from the start to the
goal.
+ * @return The "heuristic estimate" of the distance from the start to the
goal.
*/
W applyHeuristic( V current, V goal );
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
b/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
index 2172a5e..086296f 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
@@ -70,7 +70,7 @@ public final class PredecessorsList<V, WE, W>
*
* @param source the path source vertex
* @param target the path target vertex
- * @return the weighted path related to source to target
+ * @return The weighted path related to source to target
*/
public WeightedPath<V, WE, W> buildPath( V source, V target )
{
@@ -101,7 +101,7 @@ public final class PredecessorsList<V, WE, W>
* @param touch the node where search frontiers meet, producing the
shortest path
* @param target the path target vertex
* @param backwardsList the predecessor list in backwards search space
along reversed edges
- * @return the weighted path related to source to target
+ * @return The weighted path related to source to target
*/
public WeightedPath<V, WE, W> buildPath( V source, V touch, V target,
PredecessorsList<V, WE, W> backwardsList ) {
InMemoryWeightedPath<V, WE, W> path = new InMemoryWeightedPath<V, WE,
W>( source, target, weightOperations, weightedEdges );
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/ShortestDistances.java
b/src/main/java/org/apache/commons/graph/shortestpath/ShortestDistances.java
index 3588fa0..87740c8 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/ShortestDistances.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/ShortestDistances.java
@@ -82,7 +82,7 @@ final class ShortestDistances<V, W>
* the input vertex was already visited and a distance value is available
for it.
*
* @param vertex the vertex whose distance has to be retrieved
- * @return the distance related to input vertex, or null if it wasn't
previously visited.
+ * @return The distance related to input vertex, or null if it wasn't
previously visited.
*/
public W getWeight( V vertex )
{
diff --git a/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
b/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
index 0686c2b..fff28be 100644
--- a/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
+++ b/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
@@ -136,7 +136,7 @@ final class ShortestEdges<V, WE, W>
* the input vertex has an assiged weight.
*
* @param vertex the vertex for which the distance has to be retrieved
- * @return the distance related to input vertex, or null if it does not
exist
+ * @return The distance related to input vertex, or null if it does not
exist
*/
public W getWeight( V vertex )
{
diff --git
a/src/main/java/org/apache/commons/graph/spanning/SpanningTreeAlgorithmSelector.java
b/src/main/java/org/apache/commons/graph/spanning/SpanningTreeAlgorithmSelector.java
index 5986d97..c6ea571 100644
---
a/src/main/java/org/apache/commons/graph/spanning/SpanningTreeAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/SpanningTreeAlgorithmSelector.java
@@ -37,7 +37,7 @@ public interface SpanningTreeAlgorithmSelector<V, W, WE>
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
- * @return the calculated spanning tree
+ * @return The calculated spanning tree
*/
<WO extends OrderedMonoid<W>> SpanningTree<V, WE, W>
applyingBoruvkaAlgorithm( WO weightOperations );
@@ -46,7 +46,7 @@ public interface SpanningTreeAlgorithmSelector<V, W, WE>
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
- * @return the calculated spanning tree
+ * @return The calculated spanning tree
*/
<WO extends OrderedMonoid<W>> SpanningTree<V, WE, W>
applyingKruskalAlgorithm( WO weightOperations );
@@ -55,7 +55,7 @@ public interface SpanningTreeAlgorithmSelector<V, W, WE>
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
- * @return the calculated spanning tree
+ * @return The calculated spanning tree
*/
<WO extends OrderedMonoid<W>> SpanningTree<V, WE, W>
applyingPrimAlgorithm( WO weightOperations );
diff --git
a/src/main/java/org/apache/commons/graph/spanning/SpanningTreeSourceSelector.java
b/src/main/java/org/apache/commons/graph/spanning/SpanningTreeSourceSelector.java
index 259e21a..b4cdece 100644
---
a/src/main/java/org/apache/commons/graph/spanning/SpanningTreeSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/SpanningTreeSourceSelector.java
@@ -50,14 +50,14 @@ public interface SpanningTreeSourceSelector<V, W, WE>
*
* @param <WO> the type of weight operations
* @param weightOperations the weight operations
- * @return the calculated spanning tree
+ * @return The calculated spanning tree
*/
<WO extends OrderedMonoid<W>> SpanningTree<V, WE, W>
applyingReverseDeleteAlgorithm( WO weightOperations );
/**
* Selects an arbitrary source from the input Graph to calculate the
spanning tree.
*
- * @return the linked spanning tree algorithm builder
+ * @return The linked spanning tree algorithm builder
*/
SpanningTreeAlgorithmSelector<V, W, WE> fromArbitrarySource();
@@ -65,7 +65,7 @@ public interface SpanningTreeSourceSelector<V, W, WE>
* Allows specify a source vertex to calculate the spanning tree.
*
* @param source the source vertex to calculate the spanning tree.
- * @return the linked spanning tree algorithm builder
+ * @return The linked spanning tree algorithm builder
*/
<S extends V> SpanningTreeAlgorithmSelector<V, W, WE> fromSource( S source
);
diff --git a/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
b/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
index 78f5731..accdfda 100644
--- a/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
+++ b/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
@@ -79,7 +79,7 @@ final class SuperVertex<V, W, WE>
* Returns the edge with the minimum weight to other {@link SuperVertex}
* instances.
*
- * @return the minimum weight edge or <code>null</code> if there is no edge
+ * @return The minimum weight edge or <code>null</code> if there is no edge
*/
public WE getMinimumWeightEdge()
{
diff --git a/src/main/java/org/apache/commons/graph/utils/Assertions.java
b/src/main/java/org/apache/commons/graph/utils/Assertions.java
index e7421be..17b9de8 100644
--- a/src/main/java/org/apache/commons/graph/utils/Assertions.java
+++ b/src/main/java/org/apache/commons/graph/utils/Assertions.java
@@ -69,7 +69,7 @@ public final class Assertions
* @param errorMessageArgs the arguments to be substituted into the message
* template. Arguments are converted to strings using
* {@link String#valueOf(Object)}.
- * @return the non-null reference that was validated
+ * @return The non-null reference that was validated
* @throws NullPointerException if {@code reference} is null
*/
public static <T> T checkNotNull( T reference, String
errorMessageTemplate, Object... errorMessageArgs )
diff --git a/src/main/java/org/apache/commons/graph/utils/Objects.java
b/src/main/java/org/apache/commons/graph/utils/Objects.java
index d47ff1a..dfede5f 100644
--- a/src/main/java/org/apache/commons/graph/utils/Objects.java
+++ b/src/main/java/org/apache/commons/graph/utils/Objects.java
@@ -43,7 +43,7 @@ public final class Objects
* @param initialNonZeroOddNumber a non-zero, odd number used as the
initial value.
* @param multiplierNonZeroOddNumber a non-zero, odd number used as the
multiplier.
* @param objs the objects to compute hash code.
- * @return the computed hashCode.
+ * @return The computed hashCode.
*/
public static int hash( int initialNonZeroOddNumber, int
multiplierNonZeroOddNumber, Object...objs )
{
diff --git
a/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
b/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
index 1ee760f..3fda5a1 100644
---
a/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
@@ -103,7 +103,7 @@ final class DefaultVisitAlgorithmsSelector<V, E, G extends
Graph<V, E>>
*
* @param handler the handler intercepts visits
* @param enqueue defines the collection behavior used to traverse the
graph: true is a Queue, false is a Stack
- * @return the result of {@link GraphVisitHandler#onCompleted()}
+ * @return The result of {@link GraphVisitHandler#onCompleted()}
*/
private <O> O applyingSearch( GraphVisitHandler<V, E, G, O> handler,
boolean enqueue )
{
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 b2d5b3b..c065b72 100644
--- a/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
+++ b/src/main/java/org/apache/commons/graph/visit/GraphVisitHandler.java
@@ -37,7 +37,7 @@ public interface GraphVisitHandler<V, E, G extends Graph<V,
E>, O>
* <li>{@link VisitState.ABORT} terminates the visit.</li>
* </ul>
*
- * @return the state of the visit after operations on the edge
+ * @return The state of the visit after operations on the edge
*/
VisitState discoverEdge( V head, E edge, V tail );
@@ -55,7 +55,7 @@ public interface GraphVisitHandler<V, E, G extends Graph<V,
E>, O>
* <li>{@link VisitState.ABORT} terminates the visit.</li>
* </ul>
*
- * @return the state of the visit after operations on the vertex
+ * @return The state of the visit after operations on the vertex
*/
VisitState discoverVertex( V vertex );
diff --git
a/src/main/java/org/apache/commons/graph/visit/VisitAlgorithmsSelector.java
b/src/main/java/org/apache/commons/graph/visit/VisitAlgorithmsSelector.java
index 0967fe9..e616144 100644
--- a/src/main/java/org/apache/commons/graph/visit/VisitAlgorithmsSelector.java
+++ b/src/main/java/org/apache/commons/graph/visit/VisitAlgorithmsSelector.java
@@ -34,7 +34,7 @@ public interface VisitAlgorithmsSelector<V, E, G extends
Graph<V, E>>
/**
* Breadth-first search algorithm implementation.
*
- * @return the breadth first search tree
+ * @return The breadth first search tree
*/
Graph<V, E> applyingBreadthFirstSearch();
@@ -48,7 +48,7 @@ public interface VisitAlgorithmsSelector<V, E, G extends
Graph<V, E>>
/**
* Depth-first search algorithm implementation.
*
- * @return the depth first search tree
+ * @return The depth first search tree
*/
Graph<V, E> applyingDepthFirstSearch();
diff --git
a/src/main/java/org/apache/commons/graph/visit/VisitSourceSelector.java
b/src/main/java/org/apache/commons/graph/visit/VisitSourceSelector.java
index 8530e2f..2c076d9 100644
--- a/src/main/java/org/apache/commons/graph/visit/VisitSourceSelector.java
+++ b/src/main/java/org/apache/commons/graph/visit/VisitSourceSelector.java
@@ -35,7 +35,7 @@ public interface VisitSourceSelector<V, E, G extends Graph<V,
E>>
* Select the root node the search begins from.
*
* @param source the root node the search begins from
- * @return the search visit algorithm selector
+ * @return The search visit algorithm selector
*/
<S extends V> VisitAlgorithmsSelector<V, E, G> from( S source );
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 e324b97..599ce4a 100644
--- a/src/main/java/org/apache/commons/graph/weight/Monoid.java
+++ b/src/main/java/org/apache/commons/graph/weight/Monoid.java
@@ -36,14 +36,14 @@ public interface Monoid<E>
*
* @param e1 the first element
* @param e2 the second element
- * @return the result of the associative binary operation
+ * @return The result of the associative binary operation
*/
E append( E e1, E e2 );
/**
* Returns the identity value.
*
- * @return the identity value
+ * @return The identity value
*/
E identity();
@@ -51,7 +51,7 @@ public interface Monoid<E>
* Returns the inverse of the input element.
*
* @param element the input element
- * @return the inverse of the input element
+ * @return The inverse of the input element
*/
E inverse( E element );
diff --git
a/src/test/java/org/apache/commons/graph/coloring/AbstractColoringTest.java
b/src/test/java/org/apache/commons/graph/coloring/AbstractColoringTest.java
index c32bac1..0c0c4e5 100644
--- a/src/test/java/org/apache/commons/graph/coloring/AbstractColoringTest.java
+++ b/src/test/java/org/apache/commons/graph/coloring/AbstractColoringTest.java
@@ -80,7 +80,7 @@ abstract class AbstractColoringTest
* Creates a list of integer colors.
*
* @param colorNumber number of colors
- * @return the list.
+ * @return The list.
*/
protected Set<Integer> createColorsList( int colorNumber )
{
