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 b38aa31 Javadoc
b38aa31 is described below
commit b38aa318b8cb4df64b72d69d6d65470bb53fc8bb
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Jun 30 14:01:08 2026 +0000
Javadoc
---
.../apache/commons/graph/contract/Contract.java | 4 +-
.../org/apache/commons/graph/CommonsGraph.java | 74 +++++++++++-----------
.../org/apache/commons/graph/DirectedGraph.java | 4 +-
src/main/java/org/apache/commons/graph/Graph.java | 4 +-
src/main/java/org/apache/commons/graph/Mapper.java | 4 +-
.../org/apache/commons/graph/MutableGraph.java | 4 +-
src/main/java/org/apache/commons/graph/Path.java | 4 +-
.../org/apache/commons/graph/SpanningTree.java | 4 +-
.../org/apache/commons/graph/UndirectedGraph.java | 4 +-
.../java/org/apache/commons/graph/VertexPair.java | 2 +-
.../java/org/apache/commons/graph/Weighted.java | 2 +-
.../org/apache/commons/graph/WeightedPath.java | 6 +-
.../graph/builder/AbstractGraphConnection.java | 8 +--
.../builder/DefaultLinkedConnectionBuilder.java | 6 +-
.../commons/graph/builder/GraphConnection.java | 4 +-
.../commons/graph/builder/GraphConnector.java | 8 +--
.../commons/graph/builder/HeadVertexConnector.java | 6 +-
.../graph/builder/LinkedConnectionBuilder.java | 6 +-
.../commons/graph/builder/TailVertexConnector.java | 6 +-
.../commons/graph/collections/DisjointSet.java | 2 +-
.../commons/graph/collections/DisjointSetNode.java | 2 +-
.../commons/graph/collections/FibonacciHeap.java | 2 +-
.../graph/collections/FibonacciHeapNode.java | 2 +-
.../commons/graph/coloring/ColoredVertices.java | 4 +-
.../graph/coloring/ColoringAlgorithmsSelector.java | 6 +-
.../commons/graph/coloring/ColorsBuilder.java | 6 +-
.../DefaultColoringAlgorithmsSelector.java | 6 +-
.../graph/coloring/DefaultColorsBuilder.java | 4 +-
.../ConnectivityAlgorithmsSelector.java | 4 +-
.../graph/connectivity/ConnectivityBuilder.java | 4 +-
.../DefaultConnectivityAlgorithmsSelector.java | 4 +-
.../connectivity/DefaultConnectivityBuilder.java | 4 +-
.../org/apache/commons/graph/elo/PlayersRank.java | 2 +-
.../apache/commons/graph/elo/RankingSelector.java | 2 +-
.../graph/export/DefaultExportSelector.java | 4 +-
.../commons/graph/export/ExportSelector.java | 4 +-
.../commons/graph/export/NamedExportSelector.java | 4 +-
.../flow/DefaultFlowWeightedEdgesBuilder.java | 2 +-
.../commons/graph/flow/DefaultFromHeadBuilder.java | 4 +-
.../flow/DefaultMaxFlowAlgorithmSelector.java | 4 +-
.../commons/graph/flow/DefaultToTailBuilder.java | 4 +-
.../commons/graph/flow/FlowNetworkHandler.java | 4 +-
.../graph/flow/FlowWeightedEdgesBuilder.java | 2 +-
.../apache/commons/graph/flow/FromHeadBuilder.java | 4 +-
.../graph/flow/MaxFlowAlgorithmSelector.java | 4 +-
.../apache/commons/graph/flow/ToTailBuilder.java | 4 +-
.../org/apache/commons/graph/model/BaseGraph.java | 4 +-
.../commons/graph/model/BaseMutableGraph.java | 4 +-
.../commons/graph/model/DirectedMutableGraph.java | 4 +-
.../apache/commons/graph/model/InMemoryPath.java | 4 +-
.../commons/graph/model/InMemoryWeightedPath.java | 4 +-
.../commons/graph/model/MutableSpanningTree.java | 4 +-
.../apache/commons/graph/model/RevertedGraph.java | 4 +-
.../graph/model/UndirectedMutableGraph.java | 4 +-
.../graph/scc/CheriyanMehlhornGabowAlgorithm.java | 6 +-
.../graph/scc/DefaultSccAlgorithmSelector.java | 4 +-
.../commons/graph/scc/KosarajuSharirAlgorithm.java | 6 +-
.../commons/graph/scc/SccAlgorithmSelector.java | 4 +-
.../apache/commons/graph/scc/TarjanAlgorithm.java | 6 +-
.../shortestpath/AllVertexPairsShortestPath.java | 4 +-
.../commons/graph/shortestpath/Heuristic.java | 4 +-
.../graph/shortestpath/HeuristicBuilder.java | 4 +-
.../graph/shortestpath/PathSourceSelector.java | 4 +-
.../graph/shortestpath/PredecessorsList.java | 4 +-
.../graph/shortestpath/ShortestDistances.java | 4 +-
.../ShortestPathAlgorithmSelector.java | 4 +-
.../graph/shortestpath/TargetSourceSelector.java | 4 +-
.../DefaultSpanningTreeAlgorithmSelector.java | 4 +-
.../DefaultSpanningTreeSourceSelector.java | 4 +-
.../commons/graph/spanning/ShortestEdges.java | 6 +-
.../spanning/SpanningTreeAlgorithmSelector.java | 4 +-
.../graph/spanning/SpanningTreeSourceSelector.java | 4 +-
.../org/apache/commons/graph/utils/Assertions.java | 2 +-
.../commons/graph/visit/BaseGraphVisitHandler.java | 4 +-
.../visit/DefaultVisitAlgorithmsSelector.java | 6 +-
.../graph/visit/DefaultVisitSourceSelector.java | 6 +-
.../graph/visit/VisitAlgorithmsSelector.java | 6 +-
.../commons/graph/visit/VisitGraphBuilder.java | 4 +-
.../commons/graph/visit/VisitSourceSelector.java | 6 +-
.../org/apache/commons/graph/weight/Monoid.java | 2 +-
.../apache/commons/graph/weight/OrderedMonoid.java | 2 +-
81 files changed, 204 insertions(+), 204 deletions(-)
diff --git a/base/src/main/java/org/apache/commons/graph/contract/Contract.java
b/base/src/main/java/org/apache/commons/graph/contract/Contract.java
index d4ca3e5..f362967 100644
--- a/base/src/main/java/org/apache/commons/graph/contract/Contract.java
+++ b/base/src/main/java/org/apache/commons/graph/contract/Contract.java
@@ -27,8 +27,8 @@ import org.apache.commons.graph.Vertex;
/**
* Description of the Interface
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface Contract<V extends Vertex, E extends Edge>
{
diff --git a/src/main/java/org/apache/commons/graph/CommonsGraph.java
b/src/main/java/org/apache/commons/graph/CommonsGraph.java
index b893187..b1bbbf9 100644
--- a/src/main/java/org/apache/commons/graph/CommonsGraph.java
+++ b/src/main/java/org/apache/commons/graph/CommonsGraph.java
@@ -55,9 +55,9 @@ public final class CommonsGraph
/**
* Create a color builder.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <G> The Graph type
* @param graph the input graph
* @return an instance of {@link ColorsBuilder}
*/
@@ -71,7 +71,7 @@ public final class CommonsGraph
* Ranks the players (vertices) that took part in a tournament (graph)
depending on the game results (edges),
* applying the <a
href="https://en.wikipedia.org/wiki/Elo_rating_system.">Elo Rating System</a>.
*
- * @param <P> the players involved in the tournament
+ * @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
@@ -85,9 +85,9 @@ public final class CommonsGraph
/**
* Export the graph in DOT or GraphML format.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <G> The Graph type
* @param graph the input graph
* @return an instance of {@link NamedExportSelector}
*/
@@ -100,9 +100,9 @@ public final class CommonsGraph
/**
* Calculates the input graph Connected Component.
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
- * @param <G> the directed graph type
+ * @param <V> The Graph vertices type.
+ * @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
*/
@@ -115,9 +115,9 @@ public final class CommonsGraph
/**
* Find the maximum flow on the input {@link Graph}.
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <G> the Graph type
+ * @param <G> The Graph type
* @param graph the input edge-weighted graph
* @return an instance of {@link FlowWeightedEdgesBuilder}
*/
@@ -130,9 +130,9 @@ public final class CommonsGraph
/**
* Find the sortest on the input {@link Graph}
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <G> the Graph type
+ * @param <G> The Graph type
* @param graph the input edge-weighted graph
* @return the caluculated the sortest
*/
@@ -145,9 +145,9 @@ public final class CommonsGraph
/**
* Calculates the input graph Strongly Connected Component.
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
- * @param <G> the directed graph type
+ * @param <V> The Graph vertices type.
+ * @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
*/
@@ -160,9 +160,9 @@ public final class CommonsGraph
/**
* Find the minimum spanning tree on the input {@link Graph}
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <G> the Graph type
+ * @param <G> The Graph type
* @param graph the input edge-weighted graph
* @return the caluculated minimun spanning tree
*/
@@ -176,8 +176,8 @@ public final class CommonsGraph
* Creates a new {@link DirectedMutableGraph} instance where vertices
* are connected as described in the input {@link GraphConnection}
instance.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
* @param graphConnection the {@link GraphConnection} instance that
describes vertices
* @return a new {@link DirectedMutableGraph} instance
*/
@@ -190,8 +190,8 @@ public final class CommonsGraph
* Creates a new {@link UndirectedMutableGraph} instance where vertices
* are connected as described in the input {@link GraphConnection}
instance.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
* @param graphConnection the {@link GraphConnection} instance that
describes vertices
* @return a new {@link UndirectedMutableGraph} instance
*/
@@ -203,9 +203,9 @@ public final class CommonsGraph
/**
* Allows populate the given {@link MutableGraph}.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @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
*/
@@ -233,8 +233,8 @@ public final class CommonsGraph
*
* The returned {@link Graph} will be serializable if the specified {@link
Graph} is serializable.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
* @param graph the input {@link Graph}
* @return the syncronyzed graph
*/
@@ -262,8 +262,8 @@ public final class CommonsGraph
*
* The returned {@link Graph} will be serializable if the specified {@link
Graph} is serializable.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
* @param graph the input {@link Graph}
* @return the syncronyzed graph
*/
@@ -291,8 +291,8 @@ public final class CommonsGraph
*
* The returned {@link Graph} will be serializable if the specified {@link
Graph} is serializable.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
* @param graph the input {@link Graph}
* @return the synchronized graph
*/
@@ -320,8 +320,8 @@ public final class CommonsGraph
*
* The returned {@link Graph} will be serializable if the specified {@link
Graph} is serializable.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
* @param graph the input {@link Graph}
* @return the syncronyzed graph
*/
@@ -333,9 +333,9 @@ public final class CommonsGraph
/**
* Allows select a series of algorithms to apply on input graph.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @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
*/
diff --git a/src/main/java/org/apache/commons/graph/DirectedGraph.java
b/src/main/java/org/apache/commons/graph/DirectedGraph.java
index 8cf3c33..2e9b74a 100644
--- a/src/main/java/org/apache/commons/graph/DirectedGraph.java
+++ b/src/main/java/org/apache/commons/graph/DirectedGraph.java
@@ -26,8 +26,8 @@ package org.apache.commons.graph;
* {@code E} a set of ordered pairs of vertices, called arcs, directed edges,
or arrows.
* </ul>
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface DirectedGraph<V, E>
extends Graph<V, E>
diff --git a/src/main/java/org/apache/commons/graph/Graph.java
b/src/main/java/org/apache/commons/graph/Graph.java
index 204fb93..ed9d34d 100644
--- a/src/main/java/org/apache/commons/graph/Graph.java
+++ b/src/main/java/org/apache/commons/graph/Graph.java
@@ -26,8 +26,8 @@ import java.io.Serializable;
* arcs, of certain entities called vertex or node. As in mathematics, an edge
{@code (x,y)} is said to
* point or go from {@code x} to {@code y}.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface Graph<V, E>
extends Serializable
diff --git a/src/main/java/org/apache/commons/graph/Mapper.java
b/src/main/java/org/apache/commons/graph/Mapper.java
index 7fadb21..9f38244 100644
--- a/src/main/java/org/apache/commons/graph/Mapper.java
+++ b/src/main/java/org/apache/commons/graph/Mapper.java
@@ -24,8 +24,8 @@ import java.io.Serializable;
/**
* TODO Fill the java doc
*
- * @param <I> the input type
- * @param <O> the output type
+ * @param <I> The input type
+ * @param <O> The output type
*/
public interface Mapper<I, O>
extends Serializable
diff --git a/src/main/java/org/apache/commons/graph/MutableGraph.java
b/src/main/java/org/apache/commons/graph/MutableGraph.java
index 1473114..e8be4aa 100644
--- a/src/main/java/org/apache/commons/graph/MutableGraph.java
+++ b/src/main/java/org/apache/commons/graph/MutableGraph.java
@@ -22,8 +22,8 @@ package org.apache.commons.graph;
/**
* The {@code MutableGraph} is a graph that supports the addition and removal
of vertex and edges.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface MutableGraph<V, E>
extends Graph<V, E>
diff --git a/src/main/java/org/apache/commons/graph/Path.java
b/src/main/java/org/apache/commons/graph/Path.java
index 2d90372..d92a886 100644
--- a/src/main/java/org/apache/commons/graph/Path.java
+++ b/src/main/java/org/apache/commons/graph/Path.java
@@ -23,8 +23,8 @@ package org.apache.commons.graph;
* A {@code Path} in a {@link Graph} is a sequence of vertex such that from
each of its vertices there is an
* edge to the next vertex in the sequence.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface Path<V, E>
extends Graph<V, E>
diff --git a/src/main/java/org/apache/commons/graph/SpanningTree.java
b/src/main/java/org/apache/commons/graph/SpanningTree.java
index b0448e8..6f5d975 100644
--- a/src/main/java/org/apache/commons/graph/SpanningTree.java
+++ b/src/main/java/org/apache/commons/graph/SpanningTree.java
@@ -23,9 +23,9 @@ package org.apache.commons.graph;
* A {@link SpanningTree} of a connected, undirected graph is a tree
* composed of all the vertices and some (or perhaps all) of the edges of the
Graph.
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public interface SpanningTree<V, WE, W>
extends UndirectedGraph<V, WE>, Weighted<W>
diff --git a/src/main/java/org/apache/commons/graph/UndirectedGraph.java
b/src/main/java/org/apache/commons/graph/UndirectedGraph.java
index e12584a..7e87e60 100644
--- a/src/main/java/org/apache/commons/graph/UndirectedGraph.java
+++ b/src/main/java/org/apache/commons/graph/UndirectedGraph.java
@@ -23,8 +23,8 @@ package org.apache.commons.graph;
* An {@code UndirectedGraph} is a graph in which edges have no orientation,
i.e., they are not ordered pairs,
* but sets <code>{u, v}</code> (or 2-multisets) of vertices.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface UndirectedGraph<V, E>
extends Graph<V, E>
diff --git a/src/main/java/org/apache/commons/graph/VertexPair.java
b/src/main/java/org/apache/commons/graph/VertexPair.java
index b101ab1..9940567 100644
--- a/src/main/java/org/apache/commons/graph/VertexPair.java
+++ b/src/main/java/org/apache/commons/graph/VertexPair.java
@@ -29,7 +29,7 @@ import java.io.Serializable;
/**
* Indicates a vertex pair.
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
*/
public final class VertexPair<V>
implements Serializable
diff --git a/src/main/java/org/apache/commons/graph/Weighted.java
b/src/main/java/org/apache/commons/graph/Weighted.java
index 4ed7d02..a62bd19 100644
--- a/src/main/java/org/apache/commons/graph/Weighted.java
+++ b/src/main/java/org/apache/commons/graph/Weighted.java
@@ -23,7 +23,7 @@ package org.apache.commons.graph;
* A Weighted object has a property called weight, which usually denotes
* its relative importance within the domain of interest.
*
- * @param <W> the type of weight
+ * @param <W> The type of weight
*/
public interface Weighted<W>
{
diff --git a/src/main/java/org/apache/commons/graph/WeightedPath.java
b/src/main/java/org/apache/commons/graph/WeightedPath.java
index dbdcba1..14e7fce 100644
--- a/src/main/java/org/apache/commons/graph/WeightedPath.java
+++ b/src/main/java/org/apache/commons/graph/WeightedPath.java
@@ -22,9 +22,9 @@ package org.apache.commons.graph;
/**
* A {@code Path} whose edges are {@link Weighted}.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph weighted edges type
+ * @param <W> The weight type
*/
public interface WeightedPath<V, E, W>
extends Path<V, E>, Weighted<W>
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 d8b281f..2b3403f 100644
---
a/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
+++
b/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
@@ -24,8 +24,8 @@ import static
org.apache.commons.graph.utils.Assertions.checkState;
/**
* TODO fill me!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public abstract class AbstractGraphConnection<V, E>
implements GraphConnection<V, E>
@@ -36,7 +36,7 @@ public abstract class AbstractGraphConnection<V, E>
/**
* Adds a new edge to graph connector.
*
- * @param <A> the Graph edges type
+ * @param <A> The Graph edges type
* @param arc the edge to add.
* @return the {@link HeadVertexConnector}
*/
@@ -48,7 +48,7 @@ public abstract class AbstractGraphConnection<V, E>
/**
* Adds a new vertex to graph connector.
*
- * @param <N> the Graph vertex type
+ * @param <N> The Graph vertex type
* @param node the vertex to add
* @return the vertex added
*/
diff --git
a/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
b/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
index 77fa275..fad641b 100644
---
a/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
+++
b/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
@@ -26,9 +26,9 @@ import org.apache.commons.graph.MutableGraph;
/**
* TODO Fillme!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <G> The Graph type
*/
public final class DefaultLinkedConnectionBuilder<V, E, G extends
MutableGraph<V, E>>
implements LinkedConnectionBuilder<V, E, G>
diff --git
a/src/main/java/org/apache/commons/graph/builder/GraphConnection.java
b/src/main/java/org/apache/commons/graph/builder/GraphConnection.java
index 5d6b3fe..ba788b2 100644
--- a/src/main/java/org/apache/commons/graph/builder/GraphConnection.java
+++ b/src/main/java/org/apache/commons/graph/builder/GraphConnection.java
@@ -22,8 +22,8 @@ package org.apache.commons.graph.builder;
/**
* TODO Fillme!!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface GraphConnection<V, E>
{
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 f956aa0..ece543e 100644
--- a/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
+++ b/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
@@ -22,8 +22,8 @@ package org.apache.commons.graph.builder;
/**
* TODO Fillme!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface GraphConnector<V, E>
{
@@ -31,7 +31,7 @@ public interface GraphConnector<V, E>
/**
* Adds a new edge to graph.
*
- * @param <A> the Graph edges type
+ * @param <A> The Graph edges type
* @param arc the edge to add.
* @return the {@link HeadVertexConnector}
*/
@@ -40,7 +40,7 @@ public interface GraphConnector<V, E>
/**
* Adds a new vertex to graph.
*
- * @param <N> the Graph vertices type
+ * @param <N> The Graph vertices type
* @param node the vertex to add
* @return the vertex added
*/
diff --git
a/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
b/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
index df32f0c..23251ae 100644
--- a/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
+++ b/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
@@ -22,8 +22,8 @@ package org.apache.commons.graph.builder;
/**
* TODO Fillme!!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface HeadVertexConnector<V, E>
{
@@ -31,7 +31,7 @@ public interface HeadVertexConnector<V, E>
/**
* Specifies the head vertex for the edge
*
- * @param <H> the Graph vertex type
+ * @param <H> The Graph vertex type
* @param head the head vertex
* @return {@link TailVertexConnector} builded from the head
*/
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 66e5a3b..1494092 100644
---
a/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
+++
b/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
@@ -24,9 +24,9 @@ import org.apache.commons.graph.MutableGraph;
/**
* TODO Fillme!!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <G> The Graph type
*/
public interface LinkedConnectionBuilder<V, E, G extends MutableGraph<V, E>>
{
diff --git
a/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
b/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
index ac4f8d2..6384ca2 100644
--- a/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
+++ b/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
@@ -22,8 +22,8 @@ package org.apache.commons.graph.builder;
/**
* TODO Fillme!!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface TailVertexConnector<V, E>
{
@@ -31,7 +31,7 @@ public interface TailVertexConnector<V, E>
/**
* Specifies the tail vertex for the edge
*
- * @param <T> the Graph vertex type
+ * @param <T> The Graph vertex type
* @param tail the tail vertex
*/
<T extends V> void to( T tail );
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 c6ab250..9d3de0e 100644
--- a/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
+++ b/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
@@ -25,7 +25,7 @@ import java.util.Map;
/**
* Simple <a
href="https://en.wikipedia.org/wiki/Disjoint-set_data_structure">Disjoint-set</a>
implementation.
*
- * @param <E> the type of elements held in this collection.
+ * @param <E> The type of elements held in this collection.
*/
public final class DisjointSet<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 1674dfa..99dcbc8 100644
--- a/src/main/java/org/apache/commons/graph/collections/DisjointSetNode.java
+++ b/src/main/java/org/apache/commons/graph/collections/DisjointSetNode.java
@@ -22,7 +22,7 @@ package org.apache.commons.graph.collections;
/**
* The {@link DisjointSet} internal node representation.
*
- * @param <E> the type of elements held in this node
+ * @param <E> The type of elements held in this node
*/
final class DisjointSetNode<E>
implements Comparable<DisjointSetNode<E>>
diff --git
a/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
b/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
index 9f2a149..1109e2f 100644
--- a/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
+++ b/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
@@ -45,7 +45,7 @@ import java.util.Stack;
*
* <p><b>Note 2</b>: this class doesn't support {@code null} values</p>
*
- * @param <E> the type of elements held in this collection.
+ * @param <E> The type of elements held in this collection.
*/
public final class FibonacciHeap<E>
implements Queue<E>
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 b66e3c9..7f6dd3c 100644
--- a/src/main/java/org/apache/commons/graph/collections/FibonacciHeapNode.java
+++ b/src/main/java/org/apache/commons/graph/collections/FibonacciHeapNode.java
@@ -22,7 +22,7 @@ package org.apache.commons.graph.collections;
/**
* The {@link FibonacciHeap} node reference.
*
- * @param <E> the type of elements held in the {@link FibonacciHeap}
collection.
+ * @param <E> The type of elements held in the {@link FibonacciHeap}
collection.
*/
final class FibonacciHeapNode<E>
{
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 f6126c1..97f6922 100644
--- a/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
+++ b/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
@@ -29,8 +29,8 @@ import java.util.Map;
/**
* Maintains the color for each vertex and the required number of colors for
{@link org.apache.commons.graph.Graph} coloring.
*
- * @param <V> the Graph vertices type.
- * @param <C> the Color type.
+ * @param <V> The Graph vertices type.
+ * @param <C> The Color type.
*/
public final class ColoredVertices<V, C>
{
diff --git
a/src/main/java/org/apache/commons/graph/coloring/ColoringAlgorithmsSelector.java
b/src/main/java/org/apache/commons/graph/coloring/ColoringAlgorithmsSelector.java
index d2eb300..657e794 100644
---
a/src/main/java/org/apache/commons/graph/coloring/ColoringAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/coloring/ColoringAlgorithmsSelector.java
@@ -23,9 +23,9 @@ package org.apache.commons.graph.coloring;
/**
* Builder for selecting the coloring algorithm to perform.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <C> the Color vertices type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <C> The Color vertices type
*/
public interface ColoringAlgorithmsSelector<V, E, C>
{
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 e4fdcb1..bdc084d 100644
--- a/src/main/java/org/apache/commons/graph/coloring/ColorsBuilder.java
+++ b/src/main/java/org/apache/commons/graph/coloring/ColorsBuilder.java
@@ -24,8 +24,8 @@ import java.util.Set;
/**
* Builder to specify the set of colors for coloring the graph.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface ColorsBuilder<V, E>
{
@@ -33,7 +33,7 @@ public interface ColorsBuilder<V, E>
/**
* Specifies the set of colors for coloring the graph.
*
- * @param <C> the Color type.
+ * @param <C> The Color type.
* @param colors the set of colors for coloring the graph.
* @return the coloring algorithm selector.
*/
diff --git
a/src/main/java/org/apache/commons/graph/coloring/DefaultColoringAlgorithmsSelector.java
b/src/main/java/org/apache/commons/graph/coloring/DefaultColoringAlgorithmsSelector.java
index 6bd055b..0e24ee3 100644
---
a/src/main/java/org/apache/commons/graph/coloring/DefaultColoringAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/coloring/DefaultColoringAlgorithmsSelector.java
@@ -31,9 +31,9 @@ import org.apache.commons.graph.UndirectedGraph;
/**
* {@link ColoringAlgorithmsSelector} implementation.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <C> the Color vertices type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <C> The Color vertices type
*/
final class DefaultColoringAlgorithmsSelector<V, E, C>
implements ColoringAlgorithmsSelector<V, E, C>
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 f121703..ad52417 100644
--- a/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
+++ b/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
@@ -28,8 +28,8 @@ import org.apache.commons.graph.UndirectedGraph;
/**
* {@link ColorsBuilder} implementation
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public final class DefaultColorsBuilder<V, E>
implements ColorsBuilder<V, E>
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 7bb50d8..adcf681 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/ConnectivityAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/ConnectivityAlgorithmsSelector.java
@@ -25,8 +25,8 @@ import java.util.List;
/**
* Builder for selecting the connectivity algorithm to perform.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface ConnectivityAlgorithmsSelector<V, E>
{
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 1c4af5f..e113d1b 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/ConnectivityBuilder.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/ConnectivityBuilder.java
@@ -22,8 +22,8 @@ package org.apache.commons.graph.connectivity;
/**
* Builder to specify the set of vertices included into a connected component.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public interface ConnectivityBuilder<V, E>
{
diff --git
a/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
b/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
index 5934f66..75a329d 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
@@ -32,8 +32,8 @@ import org.apache.commons.graph.Graph;
/**
* TODO Fill me!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
final class DefaultConnectivityAlgorithmsSelector<V, E>
implements ConnectivityAlgorithmsSelector<V, E>
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 864ac76..be340c2 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
@@ -27,8 +27,8 @@ import org.apache.commons.graph.Graph;
/**
* TODO Fill me!!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public class DefaultConnectivityBuilder<V, E>
implements ConnectivityBuilder<V, E>
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 75f69bd..b745fc1 100644
--- a/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
+++ b/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
@@ -22,7 +22,7 @@ package org.apache.commons.graph.elo;
/**
* The player rank
*
- * @param <P> the player's type
+ * @param <P> The player's type
*/
public interface PlayersRank<P>
{
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 5db17cf..3c80c79 100644
--- a/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
+++ b/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
@@ -22,7 +22,7 @@ package org.apache.commons.graph.elo;
/**
* Ranking selector
*
- * @param <P> the player's type
+ * @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 6e0eaf1..af12730 100644
--- a/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
+++ b/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
@@ -26,8 +26,8 @@ import org.apache.commons.graph.Graph;
/**
* {@link NamedExportSelector} implementation
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
*/
public final class DefaultExportSelector<V, E>
implements NamedExportSelector<V, E>
diff --git a/src/main/java/org/apache/commons/graph/export/ExportSelector.java
b/src/main/java/org/apache/commons/graph/export/ExportSelector.java
index 174504b..35f9ae3 100644
--- a/src/main/java/org/apache/commons/graph/export/ExportSelector.java
+++ b/src/main/java/org/apache/commons/graph/export/ExportSelector.java
@@ -22,8 +22,8 @@ package org.apache.commons.graph.export;
/**
* Allows users selecting the format of graph serialization.
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
*/
public interface ExportSelector<V, E>
{
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 ca19604..c4bbb7c 100644
--- a/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
+++ b/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
@@ -22,8 +22,8 @@ package org.apache.commons.graph.export;
/**
* TODO Fill me!
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
*/
public interface NamedExportSelector<V, E>
extends ExportSelector<V, E>
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 31987ea..ca838e0 100644
---
a/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
+++
b/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
@@ -27,7 +27,7 @@ import org.apache.commons.graph.Mapper;
/**
* {@link FlowWeightedEdgesBuilder} implementation
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
*/
public final class DefaultFlowWeightedEdgesBuilder<V, WE>
diff --git
a/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java
b/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java
index e5a97a9..fda498e 100644
--- a/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java
+++ b/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java
@@ -28,9 +28,9 @@ import org.apache.commons.graph.Mapper;
* {@link FromHeadBuilder} implementation.
*
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <W> the Graph weight type
+ * @param <W> The Graph weight type
*/
final class DefaultFromHeadBuilder<V, WE, W>
implements FromHeadBuilder<V, WE, W>
diff --git
a/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java
b/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java
index 1babbf1..3c1a557 100644
---
a/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java
@@ -32,9 +32,9 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
* {@link MaxFlowAlgorithmSelector} implementation.
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <W> the Graph weight type
+ * @param <W> The Graph weight type
*/
final class DefaultMaxFlowAlgorithmSelector<V, WE, W>
implements MaxFlowAlgorithmSelector<V, WE, W>
diff --git
a/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java
b/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java
index 97358ea..dd45c65 100644
--- a/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java
+++ b/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java
@@ -27,9 +27,9 @@ import org.apache.commons.graph.Mapper;
/**
* {@link DefaultToTailBuilder} implementation.
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <W> the Graph weight type
+ * @param <W> The Graph weight type
*/
final class DefaultToTailBuilder<V, WE, W>
implements ToTailBuilder<V, WE, W>
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 1d46b27..24efaaa 100644
--- a/src/main/java/org/apache/commons/graph/flow/FlowNetworkHandler.java
+++ b/src/main/java/org/apache/commons/graph/flow/FlowNetworkHandler.java
@@ -39,8 +39,8 @@ import org.apache.commons.graph.weight.OrderedMonoid;
* Provides standard operations for max-flow algorithms,
* like Ford-Fulkerson or Edmonds-Karp.
*
- * @param <V> the vertex type
- * @param <W> the weight type
+ * @param <V> The vertex type
+ * @param <W> The weight type
*/
final class FlowNetworkHandler<V, E, W>
extends BaseGraphVisitHandler<V, E, DirectedGraph<V, E>, W>
diff --git
a/src/main/java/org/apache/commons/graph/flow/FlowWeightedEdgesBuilder.java
b/src/main/java/org/apache/commons/graph/flow/FlowWeightedEdgesBuilder.java
index f9f9911..05571eb 100644
--- a/src/main/java/org/apache/commons/graph/flow/FlowWeightedEdgesBuilder.java
+++ b/src/main/java/org/apache/commons/graph/flow/FlowWeightedEdgesBuilder.java
@@ -24,7 +24,7 @@ import org.apache.commons.graph.Mapper;
/**
* TODO Fill Me!
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
*/
public interface FlowWeightedEdgesBuilder<V, WE>
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 4979ee0..d7295ca 100644
--- a/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
+++ b/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
@@ -22,9 +22,9 @@ package org.apache.commons.graph.flow;
/**
* TODO Fill me!!!
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <W> the Graph weight type
+ * @param <W> The Graph weight type
*/
public interface FromHeadBuilder<V, WE, W>
{
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 072416e..688ac10 100644
--- a/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
+++ b/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
@@ -24,9 +24,9 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
* Maximum Flow algorithm selector
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <W> the Graph weight type
+ * @param <W> The Graph weight type
*/
public interface MaxFlowAlgorithmSelector<V, WE, W>
{
diff --git a/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java
b/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java
index 349e828..95a9ea2 100644
--- a/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java
+++ b/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java
@@ -22,9 +22,9 @@ package org.apache.commons.graph.flow;
/**
* TODO Fill me!!!
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph edges type
- * @param <W> the Graph weight type
+ * @param <W> The Graph weight type
*/
public interface ToTailBuilder<V, WE, W>
{
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 f610d55..d5b7dee 100644
--- a/src/main/java/org/apache/commons/graph/model/BaseGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/BaseGraph.java
@@ -40,8 +40,8 @@ import org.apache.commons.graph.VertexPair;
*
* This class is NOT thread safe!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public abstract class BaseGraph<V, E>
implements Graph<V, E>
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 57074e4..51e9a67 100644
--- a/src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java
@@ -29,8 +29,8 @@ import org.apache.commons.graph.VertexPair;
*
* This class is NOT thread safe!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public abstract class BaseMutableGraph<V, E>
extends BaseGraph<V, E>
diff --git
a/src/main/java/org/apache/commons/graph/model/DirectedMutableGraph.java
b/src/main/java/org/apache/commons/graph/model/DirectedMutableGraph.java
index cb4c3ea..d28f780 100644
--- a/src/main/java/org/apache/commons/graph/model/DirectedMutableGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/DirectedMutableGraph.java
@@ -32,8 +32,8 @@ import org.apache.commons.graph.VertexPair;
*
* This class is NOT thread safe!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public class DirectedMutableGraph<V, E>
extends BaseMutableGraph<V, E>
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 db5faf5..fc91a10 100644
--- a/src/main/java/org/apache/commons/graph/model/InMemoryPath.java
+++ b/src/main/java/org/apache/commons/graph/model/InMemoryPath.java
@@ -39,8 +39,8 @@ import org.apache.commons.graph.VertexPair;
* Support {@link Path} implementation, optimized for algorithms (such
Dijkstra's) that need to rebuild the path
* traversing the predecessor list bottom-up.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public class InMemoryPath<V, E>
implements Path<V, E>
diff --git
a/src/main/java/org/apache/commons/graph/model/InMemoryWeightedPath.java
b/src/main/java/org/apache/commons/graph/model/InMemoryWeightedPath.java
index 87d82f6..bea6302 100644
--- a/src/main/java/org/apache/commons/graph/model/InMemoryWeightedPath.java
+++ b/src/main/java/org/apache/commons/graph/model/InMemoryWeightedPath.java
@@ -30,9 +30,9 @@ import org.apache.commons.graph.weight.Monoid;
* Support {@link WeightedPath} implementation, optimized for algorithms (such
Dijkstra's) that need to rebuild the path
* traversing the predecessor list bottom-up.
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public final class InMemoryWeightedPath<V, WE, W>
extends InMemoryPath<V, WE>
diff --git
a/src/main/java/org/apache/commons/graph/model/MutableSpanningTree.java
b/src/main/java/org/apache/commons/graph/model/MutableSpanningTree.java
index a34b7e8..5e23e84 100644
--- a/src/main/java/org/apache/commons/graph/model/MutableSpanningTree.java
+++ b/src/main/java/org/apache/commons/graph/model/MutableSpanningTree.java
@@ -28,9 +28,9 @@ import org.apache.commons.graph.weight.Monoid;
*
* This class is NOT thread safe!
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public final class MutableSpanningTree<V, WE, W>
extends UndirectedMutableGraph<V, WE>
diff --git a/src/main/java/org/apache/commons/graph/model/RevertedGraph.java
b/src/main/java/org/apache/commons/graph/model/RevertedGraph.java
index 9f1960a..b566b7b 100644
--- a/src/main/java/org/apache/commons/graph/model/RevertedGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/RevertedGraph.java
@@ -30,8 +30,8 @@ import org.apache.commons.graph.VertexPair;
*
* It is useful for algorithms such as Kosaraju-Sharir for strongly connected
components search.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public final class RevertedGraph<V, E>
implements DirectedGraph<V, E>
diff --git
a/src/main/java/org/apache/commons/graph/model/UndirectedMutableGraph.java
b/src/main/java/org/apache/commons/graph/model/UndirectedMutableGraph.java
index ec205db..38c0fc8 100644
--- a/src/main/java/org/apache/commons/graph/model/UndirectedMutableGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/UndirectedMutableGraph.java
@@ -26,8 +26,8 @@ import org.apache.commons.graph.UndirectedGraph;
*
* This class is NOT thread safe!
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public class UndirectedMutableGraph<V, E>
extends BaseMutableGraph<V, E>
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 8f39cab..8f3b67f 100644
---
a/src/main/java/org/apache/commons/graph/scc/CheriyanMehlhornGabowAlgorithm.java
+++
b/src/main/java/org/apache/commons/graph/scc/CheriyanMehlhornGabowAlgorithm.java
@@ -32,9 +32,9 @@ 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
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
+ * @param <G> The directed graph type
*/
final class CheriyanMehlhornGabowAlgorithm<V, E>
implements SccAlgorithm<V>
diff --git
a/src/main/java/org/apache/commons/graph/scc/DefaultSccAlgorithmSelector.java
b/src/main/java/org/apache/commons/graph/scc/DefaultSccAlgorithmSelector.java
index 6d3f3b3..d979b96 100644
---
a/src/main/java/org/apache/commons/graph/scc/DefaultSccAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/scc/DefaultSccAlgorithmSelector.java
@@ -26,8 +26,8 @@ import org.apache.commons.graph.DirectedGraph;
/**
* {@link SccAlgorithmSelector} implementation
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
*/
public final class DefaultSccAlgorithmSelector<V, E>
implements SccAlgorithmSelector<V, E>
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 62bff5e..03dc79a 100644
--- a/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
+++ b/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
@@ -36,9 +36,9 @@ import org.apache.commons.graph.model.RevertedGraph;
/**
* Implements the classical Kosaraju's algorithm to find the strongly
connected components
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
- * @param <G> the directed graph type
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
+ * @param <G> The directed graph type
*/
final class KosarajuSharirAlgorithm<V, E>
implements SccAlgorithm<V>
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 dd1bf86..0e3e31d 100644
--- a/src/main/java/org/apache/commons/graph/scc/SccAlgorithmSelector.java
+++ b/src/main/java/org/apache/commons/graph/scc/SccAlgorithmSelector.java
@@ -24,8 +24,8 @@ import java.util.Set;
/**
* Allows selecting the algorithm for calculating the strongly connected
component.
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
*/
public interface SccAlgorithmSelector<V, E>
{
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 874d916..005a08b 100644
--- a/src/main/java/org/apache/commons/graph/scc/TarjanAlgorithm.java
+++ b/src/main/java/org/apache/commons/graph/scc/TarjanAlgorithm.java
@@ -33,9 +33,9 @@ import org.apache.commons.graph.DirectedGraph;
* Implements Tarjan's algorithm is a variation (slightly faster) on
KosarajuSharir's algorithm for finding
* strongly-connected components in a directed graph.
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
- * @param <G> the directed graph type
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
+ * @param <G> The directed graph type
*/
final class TarjanAlgorithm<V, E>
implements SccAlgorithm<V>
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/AllVertexPairsShortestPath.java
b/src/main/java/org/apache/commons/graph/shortestpath/AllVertexPairsShortestPath.java
index 66e8285..f70a125 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/AllVertexPairsShortestPath.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/AllVertexPairsShortestPath.java
@@ -31,9 +31,9 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
* Represents all shortest paths between all vertex pairs calculated by {@link
FloydWarshall} algorithm.
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public final class AllVertexPairsShortestPath<V, WE, W>
{
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 5772b23..70ab90f 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/Heuristic.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/Heuristic.java
@@ -23,8 +23,8 @@ package org.apache.commons.graph.shortestpath;
* An {@link Heuristic} instance is an admissible "heuristic estimate" of the
distance to the goal
* (usually denoted <i>h(x)</i>).
*
- * @param <V> the Graph vertices type
- * @param <W> the weight type
+ * @param <V> The Graph vertices type
+ * @param <W> The weight type
*/
public interface Heuristic<V, W>
{
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/HeuristicBuilder.java
b/src/main/java/org/apache/commons/graph/shortestpath/HeuristicBuilder.java
index f685528..7aeaee3 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/HeuristicBuilder.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/HeuristicBuilder.java
@@ -23,9 +23,9 @@ import org.apache.commons.graph.WeightedPath;
/**
*
- * @param <V> the Graph vertices type.
+ * @param <V> The Graph vertices type.
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public interface HeuristicBuilder<V, WE, W>
{
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
b/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
index 6b89908..69faa3d 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
@@ -23,9 +23,9 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
*
- * @param <V> the Graph vertices type.
+ * @param <V> The Graph vertices type.
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public interface PathSourceSelector<V, WE, W>
{
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 d9ddb79..2172a5e 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
@@ -32,9 +32,9 @@ import org.apache.commons.graph.weight.Monoid;
* The predecessor list is a list of vertex of a {@link
org.apache.commons.graph.Graph}.
* Each vertex' entry contains the index of its predecessor in a path through
the graph.
*
- * @param <V> the Graph vertices type
+ * @param <V> The Graph vertices type
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public final class PredecessorsList<V, WE, W>
{
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 51bc74e..3588fa0 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/ShortestDistances.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/ShortestDistances.java
@@ -28,8 +28,8 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
* Stores and compares Graph Vertices weights.
*
- * @param <V> the Graph vertices type
- * @param <W> the weight type
+ * @param <V> The Graph vertices type
+ * @param <W> The weight type
*/
final class ShortestDistances<V, W>
implements Comparator<V>
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
b/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
index a328c3e..8007476 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
@@ -25,9 +25,9 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
*
*
- * @param <V> the Graph vertices type.
+ * @param <V> The Graph vertices type.
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public interface ShortestPathAlgorithmSelector<V, WE, W>
{
diff --git
a/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
b/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
index 6f4509b..52af58e 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
@@ -24,9 +24,9 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
*
*
- * @param <V> the Graph vertices type.
+ * @param <V> The Graph vertices type.
* @param <WE> the Graph weighted edges type
- * @param <W> the weight type
+ * @param <W> The weight type
*/
public interface TargetSourceSelector<V, WE, W>
{
diff --git
a/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
b/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
index 2c4f2ba..e0c9995 100644
---
a/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
@@ -42,8 +42,8 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
* {@link SpanningTreeAlgorithmSelector} implementation.
*
- * @param <V> the Graph vertices type
- * @param <W> the weight type
+ * @param <V> The Graph vertices type
+ * @param <W> The weight type
* @param <WE> the Graph weighted edges type
*/
final class DefaultSpanningTreeAlgorithmSelector<V, W, WE>
diff --git
a/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeSourceSelector.java
b/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeSourceSelector.java
index 15fe227..a313595 100644
---
a/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeSourceSelector.java
@@ -40,8 +40,8 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
* {@link SpanningTreeSourceSelector} implementation.
*
- * @param <V> the Graph vertices type
- * @param <W> the weight type
+ * @param <V> The Graph vertices type
+ * @param <W> The weight type
* @param <WE> the Graph weighted edges type
*/
final class DefaultSpanningTreeSourceSelector<V, W, WE>
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 e730d1c..0686c2b 100644
--- a/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
+++ b/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
@@ -35,9 +35,9 @@ import org.apache.commons.graph.weight.OrderedMonoid;
* The predecessor list is a list of vertex of a {@link
org.apache.commons.graph.Graph}.
* Each vertex' entry contains the index of its predecessor in a path through
the graph.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <W> the weight type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <W> The weight type
*/
final class ShortestEdges<V, WE, W>
implements Comparator<V>
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 bea4415..5986d97 100644
---
a/src/main/java/org/apache/commons/graph/spanning/SpanningTreeAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/SpanningTreeAlgorithmSelector.java
@@ -25,8 +25,8 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
* Spanning Tree algoritms selector.
*
- * @param <V> the Graph vertices type
- * @param <W> the weight type
+ * @param <V> The Graph vertices type
+ * @param <W> The weight type
* @param <WE> the Graph weighted edges type
*/
public interface SpanningTreeAlgorithmSelector<V, W, WE>
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 375cead..259e21a 100644
---
a/src/main/java/org/apache/commons/graph/spanning/SpanningTreeSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/SpanningTreeSourceSelector.java
@@ -25,8 +25,8 @@ import org.apache.commons.graph.weight.OrderedMonoid;
/**
* Spanning Tree source selector.
*
- * @param <V> the Graph vertices type
- * @param <W> the weight type
+ * @param <V> The Graph vertices type
+ * @param <W> The weight type
* @param <WE> the Graph weighted edges type
*/
public interface SpanningTreeSourceSelector<V, W, WE>
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 dbda86c..e7421be 100644
--- a/src/main/java/org/apache/commons/graph/utils/Assertions.java
+++ b/src/main/java/org/apache/commons/graph/utils/Assertions.java
@@ -59,7 +59,7 @@ public final class Assertions
* method is not null.
*
* @param reference an object reference
- * @param <T> the reference type
+ * @param <T> The reference type
* @param errorMessageTemplate a template for the exception message should
the
* check fail. The message is formed by replacing each {@code %s}
* placeholder in the template with an argument. These are matched by
diff --git
a/src/main/java/org/apache/commons/graph/visit/BaseGraphVisitHandler.java
b/src/main/java/org/apache/commons/graph/visit/BaseGraphVisitHandler.java
index 2e6a9ad..dd269d2 100644
--- a/src/main/java/org/apache/commons/graph/visit/BaseGraphVisitHandler.java
+++ b/src/main/java/org/apache/commons/graph/visit/BaseGraphVisitHandler.java
@@ -26,8 +26,8 @@ import org.apache.commons.graph.Graph;
/**
* Base NOOP {@link GraphVisitHandler} implementation.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
*/
public class BaseGraphVisitHandler<V, E, G extends Graph<V, E>, O>
implements GraphVisitHandler<V, E, G, O>
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 8179a59..1ee760f 100644
---
a/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
@@ -35,9 +35,9 @@ import org.apache.commons.graph.VertexPair;
/**
* {@link VisitAlgorithmsSelector} implementation.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <G> The Graph type
*/
final class DefaultVisitAlgorithmsSelector<V, E, G extends Graph<V, E>>
implements VisitAlgorithmsSelector<V, E, G>
diff --git
a/src/main/java/org/apache/commons/graph/visit/DefaultVisitSourceSelector.java
b/src/main/java/org/apache/commons/graph/visit/DefaultVisitSourceSelector.java
index d8a34e6..3143400 100644
---
a/src/main/java/org/apache/commons/graph/visit/DefaultVisitSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/visit/DefaultVisitSourceSelector.java
@@ -27,9 +27,9 @@ import org.apache.commons.graph.Graph;
/**
* {@link VisitSourceSelector} implementation.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <G> The Graph type
*/
public final class DefaultVisitSourceSelector<V, E, G extends Graph<V, E>>
implements VisitSourceSelector<V, E, G>
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 894de41..0967fe9 100644
--- a/src/main/java/org/apache/commons/graph/visit/VisitAlgorithmsSelector.java
+++ b/src/main/java/org/apache/commons/graph/visit/VisitAlgorithmsSelector.java
@@ -24,9 +24,9 @@ import org.apache.commons.graph.Graph;
/**
* Applies different implementations of Graph visitor algorithms.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <G> The Graph type
*/
public interface VisitAlgorithmsSelector<V, E, G extends Graph<V, E>>
{
diff --git
a/src/main/java/org/apache/commons/graph/visit/VisitGraphBuilder.java
b/src/main/java/org/apache/commons/graph/visit/VisitGraphBuilder.java
index a41a7a9..3446fe3 100644
--- a/src/main/java/org/apache/commons/graph/visit/VisitGraphBuilder.java
+++ b/src/main/java/org/apache/commons/graph/visit/VisitGraphBuilder.java
@@ -28,8 +28,8 @@ import org.apache.commons.graph.model.UndirectedMutableGraph;
/**
* Internal Visitor helper that produces the search tree.
*
- * @param <V> the Graph vertices type.
- * @param <E> the Graph edges type.
+ * @param <V> The Graph vertices type.
+ * @param <E> The Graph edges type.
*/
final class VisitGraphBuilder<V, E, G extends Graph<V, E>>
extends BaseGraphVisitHandler<V, E, G, Graph<V, E>>
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 b89c068..8530e2f 100644
--- a/src/main/java/org/apache/commons/graph/visit/VisitSourceSelector.java
+++ b/src/main/java/org/apache/commons/graph/visit/VisitSourceSelector.java
@@ -24,9 +24,9 @@ import org.apache.commons.graph.Graph;
/**
* Search root node selector.
*
- * @param <V> the Graph vertices type
- * @param <E> the Graph edges type
- * @param <G> the Graph type
+ * @param <V> The Graph vertices type
+ * @param <E> The Graph edges type
+ * @param <G> The Graph type
*/
public interface VisitSourceSelector<V, E, G extends Graph<V, E>>
{
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 d4e6cd3..e324b97 100644
--- a/src/main/java/org/apache/commons/graph/weight/Monoid.java
+++ b/src/main/java/org/apache/commons/graph/weight/Monoid.java
@@ -24,7 +24,7 @@ import java.io.Serializable;
/**
* A {@link Monoid} is a {@link Semigroup} with an identity value.
*
- * @param <E> the type of the elements in the {@link Monoid}
+ * @param <E> The type of the elements in the {@link Monoid}
*/
public interface Monoid<E>
extends Serializable
diff --git a/src/main/java/org/apache/commons/graph/weight/OrderedMonoid.java
b/src/main/java/org/apache/commons/graph/weight/OrderedMonoid.java
index fc251e4..efa2601 100644
--- a/src/main/java/org/apache/commons/graph/weight/OrderedMonoid.java
+++ b/src/main/java/org/apache/commons/graph/weight/OrderedMonoid.java
@@ -24,7 +24,7 @@ import java.util.Comparator;
/**
* An {@link OrderedMonoid} is a {@link Monoid} with a total order defined on
it.
*
- * @param <M> the type of the elements in the {@link OrderedMonoid}
+ * @param <M> The type of the elements in the {@link OrderedMonoid}
*/
public interface OrderedMonoid<M>
extends Monoid<M>, Comparator<M>