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 16f0d95 Javadoc
16f0d95 is described below
commit 16f0d9527a100eef6088de31e7461f9c4029aa3c
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:16 2026 -0400
Javadoc
---
.../org/apache/commons/graph/CommonsGraph.java | 32 +++++++++++-----------
.../org/apache/commons/graph/DirectedGraph.java | 8 +++---
src/main/java/org/apache/commons/graph/Graph.java | 14 +++++-----
.../org/apache/commons/graph/GraphException.java | 6 ++--
.../org/apache/commons/graph/MutableGraph.java | 12 ++++----
.../java/org/apache/commons/graph/VertexPair.java | 4 +--
.../graph/builder/AbstractGraphConnection.java | 4 +--
.../builder/DefaultLinkedConnectionBuilder.java | 2 +-
.../commons/graph/builder/GraphConnector.java | 4 +--
.../commons/graph/builder/HeadVertexConnector.java | 2 +-
.../graph/builder/LinkedConnectionBuilder.java | 2 +-
.../commons/graph/builder/TailVertexConnector.java | 2 +-
.../commons/graph/collections/DisjointSet.java | 10 +++----
.../commons/graph/collections/DisjointSetNode.java | 6 ++--
.../commons/graph/collections/FibonacciHeap.java | 18 ++++++------
.../graph/collections/FibonacciHeapNode.java | 12 ++++----
.../commons/graph/coloring/ColoredVertices.java | 10 +++----
.../commons/graph/coloring/ColorsBuilder.java | 2 +-
.../DefaultColoringAlgorithmsSelector.java | 2 +-
.../graph/coloring/DefaultColorsBuilder.java | 2 +-
.../graph/coloring/NotEnoughColorsException.java | 2 +-
.../graph/connectivity/ConnectivityBuilder.java | 2 +-
.../DefaultConnectivityAlgorithmsSelector.java | 2 +-
.../connectivity/DefaultConnectivityBuilder.java | 2 +-
.../commons/graph/elo/DefaultRankingSelector.java | 2 +-
.../org/apache/commons/graph/elo/PlayersRank.java | 6 ++--
.../graph/export/DefaultExportSelector.java | 2 +-
.../commons/graph/export/GraphExportException.java | 2 +-
.../commons/graph/export/NamedExportSelector.java | 2 +-
.../flow/DefaultFlowWeightedEdgesBuilder.java | 2 +-
.../graph/flow/MaxFlowAlgorithmSelector.java | 4 +--
.../org/apache/commons/graph/model/BaseGraph.java | 6 ++--
.../commons/graph/model/BaseMutableGraph.java | 24 ++++++++--------
.../apache/commons/graph/model/InMemoryPath.java | 16 +++++------
.../commons/graph/model/InMemoryWeightedPath.java | 6 ++--
.../apache/commons/graph/model/RevertedGraph.java | 2 +-
.../graph/scc/DefaultSccAlgorithmSelector.java | 2 +-
.../commons/graph/scc/KosarajuSharirAlgorithm.java | 14 +++++-----
.../commons/graph/scc/SccAlgorithmSelector.java | 2 +-
.../commons/graph/shortestpath/Heuristic.java | 4 +--
.../graph/shortestpath/PathSourceSelector.java | 2 +-
.../graph/shortestpath/PredecessorsList.java | 16 +++++------
.../graph/shortestpath/ShortestDistances.java | 8 +++---
.../ShortestPathAlgorithmSelector.java | 6 ++--
.../graph/shortestpath/TargetSourceSelector.java | 2 +-
.../DefaultSpanningTreeAlgorithmSelector.java | 4 +--
.../commons/graph/spanning/ShortestEdges.java | 8 +++---
.../spanning/SpanningTreeAlgorithmSelector.java | 6 ++--
.../graph/spanning/SpanningTreeSourceSelector.java | 4 +--
.../apache/commons/graph/spanning/SuperVertex.java | 8 +++---
.../org/apache/commons/graph/utils/Assertions.java | 18 ++++++------
.../org/apache/commons/graph/utils/Objects.java | 10 +++----
.../visit/DefaultVisitAlgorithmsSelector.java | 6 ++--
.../graph/visit/VisitAlgorithmsSelector.java | 4 +--
.../commons/graph/visit/VisitSourceSelector.java | 2 +-
.../org/apache/commons/graph/weight/Monoid.java | 6 ++--
56 files changed, 184 insertions(+), 184 deletions(-)
diff --git a/src/main/java/org/apache/commons/graph/CommonsGraph.java
b/src/main/java/org/apache/commons/graph/CommonsGraph.java
index d47be86..91a9e57 100644
--- a/src/main/java/org/apache/commons/graph/CommonsGraph.java
+++ b/src/main/java/org/apache/commons/graph/CommonsGraph.java
@@ -58,7 +58,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
* @param <G> The Graph type
- * @param graph the input graph
+ * @param graph The input graph
* @return An instance of {@link ColorsBuilder}
*/
public static <V, E, G extends UndirectedGraph<V, E>> ColorsBuilder<V, E>
coloring( G graph )
@@ -73,7 +73,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
+ * @param tournamentGraph The graph representing the tournament
* @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 )
@@ -88,7 +88,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
* @param <G> The Graph type
- * @param graph the input graph
+ * @param graph The input graph
* @return An instance of {@link NamedExportSelector}
*/
public static <V, E, G extends Graph<V, E>> NamedExportSelector<V, E>
export( G graph )
@@ -103,7 +103,7 @@ public final class CommonsGraph
* @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.
+ * @param graph The Graph which connected component has to be verified.
* @return The Connectivity algorithm builder
*/
public static <V, E, G extends Graph<V, E>> ConnectivityBuilder<V, E>
findConnectedComponent( G graph )
@@ -118,7 +118,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <WE> the Graph edges type
* @param <G> The Graph type
- * @param graph the input edge-weighted graph
+ * @param graph The input edge-weighted graph
* @return An instance of {@link FlowWeightedEdgesBuilder}
*/
public static <V, WE, G extends DirectedGraph<V, WE>>
FlowWeightedEdgesBuilder<V, WE> findMaxFlow( G graph )
@@ -133,7 +133,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <WE> the Graph edges type
* @param <G> The Graph type
- * @param graph the input edge-weighted graph
+ * @param graph The input edge-weighted graph
* @return The caluculated the sortest
*/
public static <V, WE, G extends Graph<V, WE>> PathWeightedEdgesBuilder<V,
WE> findShortestPath( G graph )
@@ -148,7 +148,7 @@ public final class CommonsGraph
* @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.
+ * @param graph The Graph which strongly connected component has to be
verified.
* @return The SCC algoritm selector
*/
public static <V, E, G extends DirectedGraph<V, E>>
SccAlgorithmSelector<V, E> findStronglyConnectedComponent( G graph )
@@ -163,7 +163,7 @@ public final class CommonsGraph
* @param <V> The Graph vertices type
* @param <WE> the Graph edges type
* @param <G> The Graph type
- * @param graph the input edge-weighted graph
+ * @param graph The input edge-weighted graph
* @return The caluculated minimun spanning tree
*/
public static <V, WE, G extends Graph<V, WE>>
SpanningWeightedEdgeMapperBuilder<V, WE> minimumSpanningTree( G graph )
@@ -178,7 +178,7 @@ public final class CommonsGraph
*
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
- * @param graphConnection the {@link GraphConnection} instance that
describes vertices
+ * @param graphConnection The {@link GraphConnection} instance that
describes vertices
* @return A new {@link DirectedMutableGraph} instance
*/
public static <V, E> DirectedMutableGraph<V, E> newDirectedMutableGraph(
GraphConnection<V, E> graphConnection )
@@ -192,7 +192,7 @@ public final class CommonsGraph
*
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
- * @param graphConnection the {@link GraphConnection} instance that
describes vertices
+ * @param graphConnection The {@link GraphConnection} instance that
describes vertices
* @return A new {@link UndirectedMutableGraph} instance
*/
public static <V, E> UndirectedMutableGraph<V, E>
newUndirectedMutableGraph( GraphConnection<V, E> graphConnection )
@@ -206,7 +206,7 @@ public final class CommonsGraph
* @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
+ * @param graph The graph has to be populated
* @return The builder to configure vertices connection
*/
public static <V, E, G extends MutableGraph<V, E>>
LinkedConnectionBuilder<V, E, G> populate( G graph )
@@ -235,7 +235,7 @@ public final class CommonsGraph
*
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
- * @param graph the input {@link Graph}
+ * @param graph The input {@link Graph}
* @return The syncronyzed graph
*/
public static <V, E> Graph<V, E> synchronize( DirectedGraph<V, E> graph )
@@ -264,7 +264,7 @@ public final class CommonsGraph
*
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
- * @param graph the input {@link Graph}
+ * @param graph The input {@link Graph}
* @return The syncronyzed graph
*/
public static <V, E> Graph<V, E> synchronize( Graph<V, E> graph )
@@ -293,7 +293,7 @@ public final class CommonsGraph
*
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
- * @param graph the input {@link Graph}
+ * @param graph The input {@link Graph}
* @return The synchronized graph
*/
public static <V, E> Graph<V, E> synchronize( MutableGraph<V, E> graph )
@@ -322,7 +322,7 @@ public final class CommonsGraph
*
* @param <V> The Graph vertices type
* @param <E> The Graph edges type
- * @param graph the input {@link Graph}
+ * @param graph The input {@link Graph}
* @return The syncronyzed graph
*/
public static <V, E> Graph<V, E> synchronize( UndirectedGraph<V, E> graph )
@@ -336,7 +336,7 @@ public final class CommonsGraph
* @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
+ * @param graph The Graph instance to apply graph algorithms
* @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 2fa844f..c8fb904 100644
--- a/src/main/java/org/apache/commons/graph/DirectedGraph.java
+++ b/src/main/java/org/apache/commons/graph/DirectedGraph.java
@@ -36,7 +36,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
+ * @param v The vertex which inbound vertexs have to be returned
* @return The set of vertexs which are inbound to the vertex.
*/
Iterable<V> getInbound( V v );
@@ -44,7 +44,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.
+ * @param v The vertex which indegree has to be returned.
* @return The number of head endpoints adjacent to a vertex.
*/
int getInDegree( V v );
@@ -52,7 +52,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
+ * @param v The vertex which outbound vertexs have to be returned
* @return The set of vertexs which lead away from the vertex.
*/
Iterable<V> getOutbound( V v );
@@ -60,7 +60,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.
+ * @param v The vertex which indegree has to be returned.
* @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 1a790c0..dba48c8 100644
--- a/src/main/java/org/apache/commons/graph/Graph.java
+++ b/src/main/java/org/apache/commons/graph/Graph.java
@@ -39,7 +39,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.
*
- * @param e the edge to be checked
+ * @param e The edge to be checked
* @return Returns true if the edge is contained into the graph, false
otherwise
*/
boolean containsEdge( E e );
@@ -50,7 +50,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.
*
- * @param v the vertex to be checked
+ * @param v The vertex to be checked
* @return Returns true if the vertex is contained into the graph, false
otherwise
*/
boolean containsVertex( V v );
@@ -61,7 +61,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.
*
- * @param v the vertex which connected vertices have to be returned.
+ * @param v The vertex which connected vertices have to be returned.
* @return all vertices which touch this vertex.
*/
Iterable<V> getConnectedVertices( V v );
@@ -73,7 +73,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.
*
- * @param v the vertex which degree has to be returned.
+ * @param v The vertex which degree has to be returned.
* @return The number of edges incident to the vertex.
*/
int getDegree( V v );
@@ -84,8 +84,8 @@ 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.
*
- * @param source the source vertex
- * @param target the target vertex
+ * @param source The source vertex
+ * @param target The target vertex
* @return The edge with vertex source and target.
*/
E getEdge( V source, V target );
@@ -136,7 +136,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.
*
- * @param e the input edge
+ * @param e The input edge
* @return The set of vertex on this Edge.
*/
VertexPair<V> getVertices( E e );
diff --git a/src/main/java/org/apache/commons/graph/GraphException.java
b/src/main/java/org/apache/commons/graph/GraphException.java
index d25c9f3..b716a47 100644
--- a/src/main/java/org/apache/commons/graph/GraphException.java
+++ b/src/main/java/org/apache/commons/graph/GraphException.java
@@ -54,8 +54,8 @@ public class GraphException
/**
* Constructs a new graph exception with the specified detail message and
cause.
*
- * @param msg the detail message.
- * @param cause the cause
+ * @param msg The detail message.
+ * @param cause The cause
*/
public GraphException( String msg, Throwable cause )
{
@@ -65,7 +65,7 @@ public class GraphException
/**
* Constructs a new graph exception with the specified cause.
*
- * @param cause the cause
+ * @param cause The cause
*/
public GraphException( Throwable cause )
{
diff --git a/src/main/java/org/apache/commons/graph/MutableGraph.java
b/src/main/java/org/apache/commons/graph/MutableGraph.java
index e8be4aa..2603ef0 100644
--- a/src/main/java/org/apache/commons/graph/MutableGraph.java
+++ b/src/main/java/org/apache/commons/graph/MutableGraph.java
@@ -35,9 +35,9 @@ public interface MutableGraph<V, E>
* <b>NOTE</b>: implementors have to take in consideration throwing a
{@link GraphException}
* if an error occurs while performing that operation.
*
- * @param head the head vertex
- * @param e the edge has to be added in this {@code MutableGraph} instance.
- * @param tail the tail vertex
+ * @param head The head vertex
+ * @param e The edge has to be added in this {@code MutableGraph} instance.
+ * @param tail The tail vertex
*/
void addEdge( V head, E e, V tail );
@@ -47,7 +47,7 @@ public interface MutableGraph<V, E>
* <b>NOTE</b>: implementors have to take in consideration throwing a
{@link GraphException}
* if an error occurs while performing that operation.
*
- * @param v the vertex has to be added in this {@code MutableGraph}
instance.
+ * @param v The vertex has to be added in this {@code MutableGraph}
instance.
*/
void addVertex( V v );
@@ -57,7 +57,7 @@ public interface MutableGraph<V, E>
* <b>NOTE</b>: implementors have to take in consideration throwing a
{@link GraphException}
* if an error occurs while performing that operation.
*
- * @param e the edge has to be removed from this {@code MutableGraph}
instance.
+ * @param e The edge has to be removed from this {@code MutableGraph}
instance.
*/
void removeEdge( E e );
@@ -67,7 +67,7 @@ public interface MutableGraph<V, E>
* <b>NOTE</b>: implementors have to take in consideration throwing a
{@link GraphException}
* if an error occurs while performing that operation.
*
- * @param v the vertex has to be removed from this {@code MutableGraph}
instance.
+ * @param v The vertex has to be removed from this {@code MutableGraph}
instance.
*/
void removeVertex( V v );
diff --git a/src/main/java/org/apache/commons/graph/VertexPair.java
b/src/main/java/org/apache/commons/graph/VertexPair.java
index a864f0b..c2c3e0c 100644
--- a/src/main/java/org/apache/commons/graph/VertexPair.java
+++ b/src/main/java/org/apache/commons/graph/VertexPair.java
@@ -45,8 +45,8 @@ public final class VertexPair<V>
/**
* Initializes a new vertex pair.
*
- * @param head the head Vertex
- * @param tail the tail Vertex
+ * @param head The head Vertex
+ * @param tail The tail Vertex
*/
public VertexPair( V head, V tail )
{
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 f2ed926..fda4639 100644
---
a/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
+++
b/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
@@ -37,7 +37,7 @@ public abstract class AbstractGraphConnection<V, E>
* Adds a new edge to graph connector.
*
* @param <A> The Graph edges type
- * @param arc the edge to add.
+ * @param arc The edge to add.
* @return The {@link HeadVertexConnector}
*/
protected final <A extends E> HeadVertexConnector<V, E> addEdge( A arc )
@@ -49,7 +49,7 @@ public abstract class AbstractGraphConnection<V, E>
* Adds a new vertex to graph connector.
*
* @param <N> The Graph vertex type
- * @param node the vertex to add
+ * @param node The vertex to add
* @return The vertex added
*/
protected final <N extends V> N addVertex( N node )
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 fad641b..efd691a 100644
---
a/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
+++
b/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
@@ -39,7 +39,7 @@ public final class DefaultLinkedConnectionBuilder<V, E, G
extends MutableGraph<V
/**
* Creates a new {@link DefaultLinkedConnectionBuilder} for the graph.
*
- * @param graph the graph
+ * @param graph The graph
*/
public DefaultLinkedConnectionBuilder( G graph )
{
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 229f5d3..503847f 100644
--- a/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
+++ b/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
@@ -32,7 +32,7 @@ public interface GraphConnector<V, E>
* Adds a new edge to graph.
*
* @param <A> The Graph edges type
- * @param arc the edge to add.
+ * @param arc The edge to add.
* @return The {@link HeadVertexConnector}
*/
<A extends E> HeadVertexConnector<V, E> addEdge( A arc );
@@ -41,7 +41,7 @@ public interface GraphConnector<V, E>
* Adds a new vertex to graph.
*
* @param <N> The Graph vertices type
- * @param node the vertex to add
+ * @param node The vertex to add
* @return The vertex added
*/
<N extends V> N addVertex( N node );
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 23251ae..eb253d0 100644
--- a/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
+++ b/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
@@ -32,7 +32,7 @@ public interface HeadVertexConnector<V, E>
* Specifies the head vertex for the edge
*
* @param <H> The Graph vertex type
- * @param head the head vertex
+ * @param head The head vertex
* @return {@link TailVertexConnector} builded from the head
*/
<H extends V> TailVertexConnector<V, E> from( H 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 da774f4..1f21592 100644
---
a/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
+++
b/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
@@ -34,7 +34,7 @@ public interface LinkedConnectionBuilder<V, E, G extends
MutableGraph<V, E>>
/**
* Connects the graph.
*
- * @param graphConnection the {@link GraphConnection}
+ * @param graphConnection The {@link GraphConnection}
* @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/builder/TailVertexConnector.java
b/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
index 6384ca2..44e7373 100644
--- a/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
+++ b/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
@@ -32,7 +32,7 @@ public interface TailVertexConnector<V, E>
* Specifies the tail vertex for the edge
*
* @param <T> The Graph vertex type
- * @param tail the tail vertex
+ * @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 9a83acc..70ad960 100644
--- a/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
+++ b/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
@@ -38,7 +38,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
+ * @param node The input DisjointSet node for the @code{ find} operation
* @return The root node of the path
*/
private DisjointSetNode<E> find( DisjointSetNode<E> node )
@@ -53,7 +53,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
+ * @param e The element has to be find in this {@code DisjointSet} instance
* @return The value found
*/
public E find( E e )
@@ -74,7 +74,7 @@ public final class DisjointSet<E>
* Retrieves the {@code DisjointSetNode} from the {@link #disjointSets},
* 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
+ * @param e The element which related subset has to be returned
* @return The input element {@code DisjointSetNode}
*/
private DisjointSetNode<E> getNode( E e )
@@ -93,8 +93,8 @@ public final class DisjointSet<E>
/**
* Join two subsets into a single subset, performing the merge by applying
the <i>union by rank</i>.
*
- * @param e1 the first element which related subset has to be merged
- * @param e2 the second element which related subset has to be merged
+ * @param e1 The first element which related subset has to be merged
+ * @param e2 The second element which related subset has to be merged
*/
public void union( E e1, E e2 )
{
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 8ab68eb..5e9d18f 100644
--- a/src/main/java/org/apache/commons/graph/collections/DisjointSetNode.java
+++ b/src/main/java/org/apache/commons/graph/collections/DisjointSetNode.java
@@ -46,7 +46,7 @@ final class DisjointSetNode<E>
/**
* Creates a new {@link DisjointSet} node with the given value.
*
- * @param element the node value has to be stored.
+ * @param element The node value has to be stored.
*/
public DisjointSetNode( E element )
{
@@ -102,7 +102,7 @@ final class DisjointSetNode<E>
/**
* Sets the reference to a new parent node.
*
- * @param parent the reference to a new parent node.
+ * @param parent The reference to a new parent node.
*/
public void setParent( DisjointSetNode<E> parent )
{
@@ -112,7 +112,7 @@ final class DisjointSetNode<E>
/**
* Sets a new different rank.
*
- * @param rank the new rank to this node.
+ * @param rank The new rank to this node.
*/
public void setRank( int rank )
{
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 4cb6f89..fb283ac 100644
--- a/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
+++ b/src/main/java/org/apache/commons/graph/collections/FibonacciHeap.java
@@ -98,7 +98,7 @@ public final class FibonacciHeap<E>
/**
* Creates a {@link FibonacciHeap} that orders its elements according to
the specified comparator.
*
- * @param comparator the comparator that will be used to order this queue.
+ * @param comparator The comparator that will be used to order this queue.
* If null, the natural ordering of the elements will be
used.
*/
public FibonacciHeap( /* @Nullable */Comparator<? super E> comparator )
@@ -163,7 +163,7 @@ public final class FibonacciHeap<E>
* 5 else CUT(H,y,z)
* 6 CASCADING-CUT(H,z)</pre>
*
- * @param y the target node to apply CASCADING-CUT
+ * @param y The target node to apply CASCADING-CUT
*/
private void cascadingCut( FibonacciHeapNode<E> y )
{
@@ -206,8 +206,8 @@ public final class FibonacciHeap<E>
* Compare the given objects according to the specified comparator if not
null,
* according to their natural ordering otherwise.
*
- * @param o1 the first {@link FibonacciHeap} node to be compared
- * @param o2 the second {@link FibonacciHeap} node to be compared
+ * @param o1 The first {@link FibonacciHeap} node to be compared
+ * @param o2 The second {@link FibonacciHeap} node to be compared
* @return A negative integer, zero, or a positive integer as the first
argument is
* less than, equal to, or greater than the second
*/
@@ -390,8 +390,8 @@ public final class FibonacciHeap<E>
* 3 p[x] ← NIL
* 4 mark[x] ← FALSE</pre>
*
- * @param x the node has to be removed from {@code y} children
- * @param y the node has to be updated
+ * @param x The node has to be removed from {@code y} children
+ * @param y The node has to be updated
*/
private void cut( FibonacciHeapNode<E> x, FibonacciHeapNode<E> y )
{
@@ -444,8 +444,8 @@ public final class FibonacciHeap<E>
* 2 make y a child of x, incrementing degree[x]
* 3 mark[y] FALSE</pre>
*
- * @param y the node has to be removed from the root list
- * @param x the node has to become fater of {@code y}
+ * @param y The node has to be removed from the root list
+ * @param x The node has to become fater of {@code y}
*/
private void link( FibonacciHeapNode<E> y, FibonacciHeapNode<E> x )
{
@@ -480,7 +480,7 @@ public final class FibonacciHeap<E>
/**
* Moves the target node in the {@code H} root nodes.
*
- * @param node the node has to be moved in the {@code H} root nodes
+ * @param node The node has to be moved in the {@code H} root nodes
* @see #add(Object)
* @see #consolidate()
* @see #cut(FibonacciHeapNode, FibonacciHeapNode)
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 091b7e2..69791db 100644
--- a/src/main/java/org/apache/commons/graph/collections/FibonacciHeapNode.java
+++ b/src/main/java/org/apache/commons/graph/collections/FibonacciHeapNode.java
@@ -66,7 +66,7 @@ final class FibonacciHeapNode<E>
/**
* Build a new {@link FibonacciHeap} node with the given value.
*
- * @param element the node value has to be stored.
+ * @param element The node value has to be stored.
*/
public FibonacciHeapNode( E element )
{
@@ -180,7 +180,7 @@ final class FibonacciHeapNode<E>
/**
* Sets the reference to the first child node.
*
- * @param child the reference to the first child node.
+ * @param child The reference to the first child node.
*/
public void setChild( FibonacciHeapNode<E> child )
{
@@ -190,7 +190,7 @@ final class FibonacciHeapNode<E>
/**
* Sets the left node reference.
*
- * @param left the left node reference.
+ * @param left The left node reference.
*/
public void setLeft( FibonacciHeapNode<E> left )
{
@@ -200,7 +200,7 @@ final class FibonacciHeapNode<E>
/**
* Flags the current node as marked.
*
- * @param marked the current node mark status.
+ * @param marked The current node mark status.
*/
public void setMarked( boolean marked )
{
@@ -210,7 +210,7 @@ final class FibonacciHeapNode<E>
/**
* Sets the reference to the parent node.
*
- * @param parent the reference to the parent node
+ * @param parent The reference to the parent node
*/
public void setParent( FibonacciHeapNode<E> parent )
{
@@ -220,7 +220,7 @@ final class FibonacciHeapNode<E>
/**
* Sets the right node reference.
*
- * @param left the right node reference.
+ * @param left The right node reference.
*/
public void setRight( FibonacciHeapNode<E> right )
{
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 fcdc336..6f67fb7 100644
--- a/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
+++ b/src/main/java/org/apache/commons/graph/coloring/ColoredVertices.java
@@ -50,8 +50,8 @@ public final class ColoredVertices<V, C>
/**
* Store the input vertex color.
*
- * @param v the vertex for which storing the color.
- * @param color the input vertex color.
+ * @param v The vertex for which storing the color.
+ * @param color The input vertex color.
*/
void addColor( V v, C color )
{
@@ -70,7 +70,7 @@ public final class ColoredVertices<V, C>
/**
* Tests if the 'vertex' is colored.
*
- * @param vertex the vertex
+ * @param vertex The vertex
* @return true if the colored vertex is contained into the map, false
otherwise
*/
public boolean containsColoredVertex( V vertex )
@@ -81,7 +81,7 @@ public final class ColoredVertices<V, C>
/**
* Returns the color associated to the input vertex.
*
- * @param v the vertex for which getting the color.
+ * @param v The vertex for which getting the color.
* @return The color associated to the input vertex.
*/
public C getColor( V v )
@@ -104,7 +104,7 @@ public final class ColoredVertices<V, C>
/**
* Remove the input vertex color.
*
- * @param v the vertex for which storing the color.
+ * @param v The vertex for which storing the color.
*/
void removeColor( V v )
{
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 3ba3de2..aadc26e 100644
--- a/src/main/java/org/apache/commons/graph/coloring/ColorsBuilder.java
+++ b/src/main/java/org/apache/commons/graph/coloring/ColorsBuilder.java
@@ -34,7 +34,7 @@ public interface ColorsBuilder<V, E>
* Specifies the set of colors for coloring the graph.
*
* @param <C> The Color type.
- * @param colors the set of colors for coloring the graph.
+ * @param colors The set of colors for coloring the graph.
* @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/DefaultColoringAlgorithmsSelector.java
b/src/main/java/org/apache/commons/graph/coloring/DefaultColoringAlgorithmsSelector.java
index 0e24ee3..b39a903 100644
---
a/src/main/java/org/apache/commons/graph/coloring/DefaultColoringAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/coloring/DefaultColoringAlgorithmsSelector.java
@@ -148,7 +148,7 @@ final class DefaultColoringAlgorithmsSelector<V, E, C>
* This is the recursive step.
*
* @param result The set that will be returned
- * @param element the element
+ * @param element The element
* @return true if there is a valid coloring for the graph, false
otherwise.
*/
private boolean backtraking( int currentVertexIndex, List<V> verticesList,
ColoredVertices<V, C> coloredVertices )
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 ad52417..0f3b4bd 100644
--- a/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
+++ b/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
@@ -40,7 +40,7 @@ public final class DefaultColorsBuilder<V, E>
/**
* Creates a new instance of {@link DefaultColorsBuilder} for the input
graph.
*
- * @param graph the graph
+ * @param graph The graph
*/
public DefaultColorsBuilder( UndirectedGraph<V, E> graph )
{
diff --git
a/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
b/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
index bd91635..5cf11c2 100644
---
a/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
+++
b/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
@@ -39,7 +39,7 @@ public class NotEnoughColorsException
/**
* Creates new instance of {@link NotEnoughColorsException}.
*
- * @param colors the set of color.
+ * @param colors The set of color.
*/
public NotEnoughColorsException( Set<?> colors )
{
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 d2fd9d6..440fead 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/ConnectivityBuilder.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/ConnectivityBuilder.java
@@ -38,7 +38,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.
+ * @param vertices The set of vertices included into a connected component.
* @return The connectivity algorithm selector.
*/
ConnectivityAlgorithmsSelector<V, E> includingVertices( V... vertices );
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 75a329d..2ab1978 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
@@ -46,7 +46,7 @@ final class DefaultConnectivityAlgorithmsSelector<V, E>
/**
* Create a new instance of {@link DefaultConnectivityAlgorithmsSelector}
calculated for a set of included vertices
*
- * @param graph the graph
+ * @param graph The graph
* @param includedVertices included vertices
*/
public DefaultConnectivityAlgorithmsSelector( Graph<V, E> graph,
Iterable<V> includedVertices )
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 be340c2..75b3e42 100644
---
a/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
+++
b/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
@@ -39,7 +39,7 @@ public class DefaultConnectivityBuilder<V, E>
/**
* Creates a nw instance of {@link DefaultConnectivityBuilder}
*
- * @param graph the graph
+ * @param graph The graph
*/
public DefaultConnectivityBuilder( Graph<V, E> graph )
{
diff --git
a/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
b/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
index 4cdac03..4e4399a 100644
--- a/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
+++ b/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
@@ -37,7 +37,7 @@ public final class DefaultRankingSelector<P>
/**
* Creates a new instance of {@link DefaultRankingSelector} for gived
graph.
*
- * @param tournamentGraph the graph
+ * @param tournamentGraph The graph
*/
public DefaultRankingSelector( DirectedGraph<P, GameResult>
tournamentGraph )
{
diff --git a/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
b/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
index b745fc1..e0b50da 100644
--- a/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
+++ b/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
@@ -30,7 +30,7 @@ public interface PlayersRank<P>
/**
* Returns the ranking for the player
*
- * @param player the player
+ * @param player The player
* @return Returns the ranking for the player
*/
Double getRanking( P player );
@@ -38,8 +38,8 @@ public interface PlayersRank<P>
/**
* Update the ranking for the player
*
- * @param player the player
- * @param ranking the ranking value
+ * @param player The player
+ * @param ranking The ranking value
*/
void updateRanking( P player, Double ranking );
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 af12730..c14fb95 100644
--- a/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
+++ b/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
@@ -40,7 +40,7 @@ public final class DefaultExportSelector<V, E>
/**
* Creates a new instance of export selector for the given graph
*
- * @param graph the graph
+ * @param graph The graph
*/
public DefaultExportSelector( Graph<V, E> graph )
{
diff --git
a/src/main/java/org/apache/commons/graph/export/GraphExportException.java
b/src/main/java/org/apache/commons/graph/export/GraphExportException.java
index ebd546b..86075e7 100644
--- a/src/main/java/org/apache/commons/graph/export/GraphExportException.java
+++ b/src/main/java/org/apache/commons/graph/export/GraphExportException.java
@@ -34,7 +34,7 @@ public final class GraphExportException
/**
* Constructs a new graph export exception with the specified detail
message.
*
- * @param cause the cause
+ * @param cause The cause
* @param messagePattern A <a href="../util/Formatter.html#syntax">format
string</a>
* @param messageArguments Arguments referenced by the format specifiers
in the format string
* @see java.lang.String#format(String, Object...)
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 06b0e91..21f2e1d 100644
--- a/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
+++ b/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
@@ -32,7 +32,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}
+ * @param name The name to identify the {@link
org.apache.commons.graph.Graph}
* @return The graph export format selector
*/
ExportSelector<V, E> withName( String name );
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 ca838e0..76ade23 100644
---
a/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
+++
b/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
@@ -39,7 +39,7 @@ public final class DefaultFlowWeightedEdgesBuilder<V, WE>
/**
* Creates a new instance of flow weighted edges builder for the given
graph
*
- * @param graph the graph
+ * @param graph The graph
*/
public DefaultFlowWeightedEdgesBuilder( DirectedGraph<V, WE> graph )
{
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 f321679..150b259 100644
--- a/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
+++ b/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
@@ -35,7 +35,7 @@ public interface MaxFlowAlgorithmSelector<V, WE, W>
* Calculates the maximum flow using the Edmonds-Karp algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the class responsible for operations on weights
+ * @param weightOperations The class responsible for operations on weights
* @return The max flow calculate with Edmonds and Karp algorithm
*/
<WO extends OrderedMonoid<W>> W applyingEdmondsKarp( WO weightOperations );
@@ -44,7 +44,7 @@ public interface MaxFlowAlgorithmSelector<V, WE, W>
* Calculates the maximum flow using the Ford-Fulkerson method.
*
* @param <WO> the type of weight operations
- * @param weightOperations the class responsible for operations on weights
+ * @param weightOperations The class responsible for operations on weights
* @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 92b40bd..c0f4cc5 100644
--- a/src/main/java/org/apache/commons/graph/model/BaseGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/BaseGraph.java
@@ -53,14 +53,14 @@ public abstract class BaseGraph<V, E>
* Ensures the truth of an expression involving one or more parameters to
the
* calling method.
*
- * @param expression a boolean expression
- * @param errorMessageTemplate a template for the exception message should
the
+ * @param expression A boolean expression
+ * @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
* position - the first {@code %s} gets {@code errorMessageArgs[0]},
etc.
* Unmatched arguments will be appended to the formatted message in
square
* braces. Unmatched placeholders will be left as-is.
- * @param errorMessageArgs the arguments to be substituted into the message
+ * @param errorMessageArgs The arguments to be substituted into the message
* template. Arguments are converted to strings using
* {@link String#valueOf(Object)}.
* @throws GraphException if {@code expression} is false
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 51e9a67..4e09252 100644
--- a/src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/BaseMutableGraph.java
@@ -74,39 +74,39 @@ public abstract class BaseMutableGraph<V, E>
/**
* Executes additional actions to edge that will be added
*
- * @param head the head vertex
- * @param e the edge
- * @param tail the tail vertex
+ * @param head The head vertex
+ * @param e The edge
+ * @param tail The tail vertex
*/
protected abstract void decorateAddEdge( V head, E e, V tail );
/**
* Executes additional actions to vertex that will be added
*
- * @param v the vertex
+ * @param v The vertex
*/
protected abstract void decorateAddVertex( V v );
/**
* Executes additional actions to edge that will be removed
*
- * @param e the edge
+ * @param e The edge
*/
protected abstract void decorateRemoveEdge( E e );
/**
* Executes additional actions to vertex that will be removed
*
- * @param v the vertex
+ * @param v The vertex
*/
protected abstract void decorateRemoveVertex( V v );
/**
* Performs the internal operations to add the edge
*
- * @param head the head vertex
- * @param e the edge
- * @param tail the tail vertex
+ * @param head The head vertex
+ * @param e The edge
+ * @param tail The tail vertex
*/
protected void internalAddEdge( V head, E e, V tail )
{
@@ -124,9 +124,9 @@ public abstract class BaseMutableGraph<V, E>
/**
* Performs the internal operations to remove the edge.
*
- * @param head the head vertex
- * @param e the edge
- * @param tail the tail vertex
+ * @param head The head vertex
+ * @param e The edge
+ * @param tail The tail vertex
*/
protected void internalRemoveEdge( V head, E e, V tail )
{
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 fc91a10..341c547 100644
--- a/src/main/java/org/apache/commons/graph/model/InMemoryPath.java
+++ b/src/main/java/org/apache/commons/graph/model/InMemoryPath.java
@@ -65,8 +65,8 @@ public class InMemoryPath<V, E>
/**
* Creates a new instance of {@link InMemoryPath} from {@code start}
vertex to {@code taget} vertex
*
- * @param start the start vertex.
- * @param target the target vertex.
+ * @param start The start vertex.
+ * @param target The target vertex.
*/
public InMemoryPath( V start, V target )
{
@@ -86,9 +86,9 @@ public class InMemoryPath<V, E>
/**
* Adds the edge in head.
*
- * @param head the head vertex
- * @param edge the edge
- * @param tail the tail vertex
+ * @param head The head vertex
+ * @param edge The edge
+ * @param tail The tail vertex
*/
public void addConnectionInHead( V head, E edge, V tail )
{
@@ -106,9 +106,9 @@ public class InMemoryPath<V, E>
/**
* Adds the edge in tail.
*
- * @param head the head vertex
- * @param edge the edge
- * @param tail the tail vertex
+ * @param head The head vertex
+ * @param edge The edge
+ * @param tail The tail vertex
*/
public void addConnectionInTail( V head, E edge, V tail )
{
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 bea6302..d911195 100644
--- a/src/main/java/org/apache/commons/graph/model/InMemoryWeightedPath.java
+++ b/src/main/java/org/apache/commons/graph/model/InMemoryWeightedPath.java
@@ -50,8 +50,8 @@ public final class InMemoryWeightedPath<V, WE, W>
/**
* Creates a new instance of {@link InMemoryWeightedPath}.
*
- * @param start the start vertex
- * @param target the target vertex
+ * @param start The start vertex
+ * @param target The target vertex
* @param weightOperations
* @param weightedEdges
*/
@@ -133,7 +133,7 @@ public final class InMemoryWeightedPath<V, WE, W>
/**
* Increase the path weight with the weight of the input weighted edge.
*
- * @param edge the edge whose weight is used to increase the path weight
+ * @param edge The edge whose weight is used to increase the path weight
*/
private void increaseWeight( WE edge )
{
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 b566b7b..e3ccd8f 100644
--- a/src/main/java/org/apache/commons/graph/model/RevertedGraph.java
+++ b/src/main/java/org/apache/commons/graph/model/RevertedGraph.java
@@ -47,7 +47,7 @@ public final class RevertedGraph<V, E>
/**
* Build a new DirectedGraph mirror.
*
- * @param directedGraph the DirectedGraph has to be adapted
+ * @param directedGraph The DirectedGraph has to be adapted
*/
public RevertedGraph( DirectedGraph<V, E> directedGraph )
{
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 d979b96..d1e9b8f 100644
---
a/src/main/java/org/apache/commons/graph/scc/DefaultSccAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/scc/DefaultSccAlgorithmSelector.java
@@ -39,7 +39,7 @@ public final class DefaultSccAlgorithmSelector<V, E>
/**
* Create a default {@link SccAlgorithmSelector} for the given {@link
org.apache.commons.graph.Graph}.
*
- * @param graph the {@link org.apache.commons.graph.Graph}.
+ * @param graph The {@link org.apache.commons.graph.Graph}.
*/
public DefaultSccAlgorithmSelector( final DirectedGraph<V, E> graph )
{
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 641bc04..37d4c8b 100644
--- a/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
+++ b/src/main/java/org/apache/commons/graph/scc/KosarajuSharirAlgorithm.java
@@ -50,7 +50,7 @@ final class KosarajuSharirAlgorithm<V, E>
/**
* Create a new {@link KosarajuSharirAlgorithm} instance for the given
{@link org.apache.commons.graph.Graph}.
*
- * @param graph the {@link org.apache.commons.graph.Graph} on which to
apply the algorithm
+ * @param graph The {@link org.apache.commons.graph.Graph} on which to
apply the algorithm
*/
public KosarajuSharirAlgorithm( final DirectedGraph<V, E> graph )
{
@@ -60,8 +60,8 @@ final class KosarajuSharirAlgorithm<V, E>
/**
* Performs a depth-first search to create a recursive vertex list.
*
- * @param source the starting vertex
- * @param visitedVertices a {@link Set} containing all visited vertices
+ * @param source The starting vertex
+ * @param visitedVertices A {@link Set} containing all visited vertices
* @return The recursively expanded vertex list for Kosaraju's algorithm
*/
private List<V> getExpandedVertexList( final V source, final Set<V>
visitedVertices )
@@ -140,7 +140,7 @@ final class KosarajuSharirAlgorithm<V, E>
* Applies the classical Kosaraju's algorithm to find the strongly
connected components of
* a vertex <code>source</code>.
*
- * @param source the source vertex to start the search from
+ * @param source The source vertex to start the search from
* @return The input graph strongly connected component.
*/
public Set<V> perform( final V source )
@@ -168,9 +168,9 @@ final class KosarajuSharirAlgorithm<V, E>
* been visited yet, while in the second step we search for vertices that
have already
* been visited.</p>
*
- * @param g the graph to be search
- * @param source the start vertex
- * @param coll the recursive collection of visited vertices
+ * @param g The graph to be search
+ * @param source The start vertex
+ * @param coll The recursive collection of visited vertices
* @param visited contains vertices that have been already visited
* @param forward <code>true</code> for the first step of Kosaraju's
algorithm,
* <code>false</code> for the second step.
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 bdefe19..50feb50 100644
--- a/src/main/java/org/apache/commons/graph/scc/SccAlgorithmSelector.java
+++ b/src/main/java/org/apache/commons/graph/scc/SccAlgorithmSelector.java
@@ -51,7 +51,7 @@ public interface SccAlgorithmSelector<V, E>
* Applies the classical Kosaraju's algorithm to find the strongly
connected components of
* a vertex <code>source</code>.
*
- * @param source the source vertex to start the search from
+ * @param source The source vertex to start the search from
* @return The input graph strongly connected component.
*/
Set<V> applyingKosarajuSharir( V source );
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 4a33254..752d409 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/Heuristic.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/Heuristic.java
@@ -32,8 +32,8 @@ public interface Heuristic<V, W>
/**
* Applies the <i>h(x)</i> "heuristic estimate" of the distance from the
start to the goal.
*
- * @param current the current visited Vertex in the Graph.
- * @param goal the goal of the Graph visit.
+ * @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.
*/
W applyHeuristic( V current, V goal );
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 50f986b..37b9acd 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/PathSourceSelector.java
@@ -34,7 +34,7 @@ public interface PathSourceSelector<V, WE, W>
* Calculates all vertices shortest paths using the FloydWarshall's
algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the weight operations needed for the algorithm
+ * @param weightOperations The weight operations needed for the algorithm
* @return A data structure which contains all vertex pairs shortest path.
*/
<WO extends OrderedMonoid<W>> AllVertexPairsShortestPath<V, WE, W>
applyingFloydWarshall( WO weightOperations );
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 086296f..2f46efb 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/PredecessorsList.java
@@ -57,8 +57,8 @@ public final class PredecessorsList<V, WE, W>
/**
* Add an edge in the predecessor list associated to the input vertex.
*
- * @param tail the predecessor vertex
- * @param head the edge that succeeds to the input vertex
+ * @param tail The predecessor vertex
+ * @param head The edge that succeeds to the input vertex
*/
public void addPredecessor( V tail, V head )
{
@@ -68,8 +68,8 @@ public final class PredecessorsList<V, WE, W>
/**
* Build a {@link WeightedPath} instance related to source-target path.
*
- * @param source the path source vertex
- * @param target the path target vertex
+ * @param source The path source vertex
+ * @param target The path target vertex
* @return The weighted path related to source to target
*/
public WeightedPath<V, WE, W> buildPath( V source, V target )
@@ -97,10 +97,10 @@ public final class PredecessorsList<V, WE, W>
/**
* Build a {@link WeightedPath} instance related to source-target path.
*
- * @param source the path source vertex
- * @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
+ * @param source The path source vertex
+ * @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
*/
public WeightedPath<V, WE, W> buildPath( V source, V touch, V target,
PredecessorsList<V, WE, W> backwardsList ) {
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 87740c8..4e35ac5 100644
--- a/src/main/java/org/apache/commons/graph/shortestpath/ShortestDistances.java
+++ b/src/main/java/org/apache/commons/graph/shortestpath/ShortestDistances.java
@@ -47,7 +47,7 @@ final class ShortestDistances<V, W>
/**
* Checks if the input {@code Vertex} was already visited.
*
- * @param vertex the input {@code Vertex}
+ * @param vertex The input {@code Vertex}
* @return true if the input {@code Vertex} was already visited, false
otherwise.
*/
public boolean alreadyVisited( V vertex )
@@ -81,7 +81,7 @@ final class ShortestDistances<V, W>
* <b>NOTE</b>: the method {@link alreadyVisited} should be used first to
check if
* the input vertex was already visited and a distance value is available
for it.
*
- * @param vertex the vertex whose distance has to be retrieved
+ * @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.
*/
public W getWeight( V vertex )
@@ -92,8 +92,8 @@ final class ShortestDistances<V, W>
/**
* Update the input vertex distance.
*
- * @param vertex the vertex for which the distance has to be updated
- * @param distance the new input vertex distance
+ * @param vertex The vertex for which the distance has to be updated
+ * @param distance The new input vertex distance
*/
public void setWeight( V vertex, W distance )
{
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 f25488b..f2d6bf3 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/ShortestPathAlgorithmSelector.java
@@ -36,7 +36,7 @@ public interface ShortestPathAlgorithmSelector<V, WE, W>
* Calculates the shortest path using the A* algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the class responsible for operations on weights
+ * @param weightOperations The class responsible for operations on weights
* @return
*/
<WO extends OrderedMonoid<W>> HeuristicBuilder<V, WE, W> applyingAStar( WO
weightOperations );
@@ -45,7 +45,7 @@ public interface ShortestPathAlgorithmSelector<V, WE, W>
* Calculates the shortest path using bidirectional Dijkstra's algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the class responsible for operations on weights
+ * @param weightOperations The class responsible for operations on weights
* @return A path which describes the shortest path, if any, otherwise a
{@link PathNotFoundException} will be thrown
*/
<WO extends OrderedMonoid<W>> WeightedPath<V, WE, W>
applyingBidirectionalDijkstra( WO weightOperations );
@@ -54,7 +54,7 @@ public interface ShortestPathAlgorithmSelector<V, WE, W>
* Calculates the shortest path using Dijkstra's algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the class responsible for operations on weights
+ * @param weightOperations The class responsible for operations on weights
* @return A path which describes the shortest path, if any, otherwise a
{@link PathNotFoundException} will be thrown
*/
<WO extends OrderedMonoid<W>> WeightedPath<V, WE, W> applyingDijkstra( WO
weightOperations );
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 3aa9fde..4c7bfad 100644
---
a/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/shortestpath/TargetSourceSelector.java
@@ -35,7 +35,7 @@ public interface TargetSourceSelector<V, WE, W>
* Calculates the shortest path using the BellmannFord's algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the weight operations needed for the algorithm
+ * @param weightOperations The weight operations needed for the algorithm
* @return A data structure which contains all vertex pairs shortest path.
*/
<WO extends OrderedMonoid<W>> AllVertexPairsShortestPath<V, WE, W>
applyingBelmannFord( WO weightOperations );
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 e0c9995..7a9ae5e 100644
---
a/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/DefaultSpanningTreeAlgorithmSelector.java
@@ -62,8 +62,8 @@ final class DefaultSpanningTreeAlgorithmSelector<V, W, WE>
* Creates a default {@link SpanningTreeAlgorithmSelector} for the given
{@link Graph} and
* start vertex.
*
- * @param graph the {@link Graph} to be used.
- * @param source the start vertex.
+ * @param graph The {@link Graph} to be used.
+ * @param source The start vertex.
*/
public DefaultSpanningTreeAlgorithmSelector( final Graph<V, WE> graph,
Mapper<WE, W> weightedEdges, final V source )
{
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 5600fdf..ac9fe11 100644
--- a/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
+++ b/src/main/java/org/apache/commons/graph/spanning/ShortestEdges.java
@@ -76,8 +76,8 @@ final class ShortestEdges<V, WE, W>
/**
* Add an edge in the predecessor list associated to the input vertex.
*
- * @param tail the predecessor vertex
- * @param head the edge that succeeds to the input vertex
+ * @param tail The predecessor vertex
+ * @param head The edge that succeeds to the input vertex
*/
public void addPredecessor( V tail, WE head )
{
@@ -135,7 +135,7 @@ final class ShortestEdges<V, WE, W>
* <b>NOTE</b>: the method {@link hasWeight} should be used first to check
if
* the input vertex has an assiged weight.
*
- * @param vertex the vertex for which the distance has to be retrieved
+ * @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
*/
public W getWeight( V vertex )
@@ -158,7 +158,7 @@ final class ShortestEdges<V, WE, W>
/**
* Checks if there is a weight related to the input {@code Vertex}.
*
- * @param vertex the input {@code Vertex}
+ * @param vertex The input {@code Vertex}
* @return true if there is a weight for the input {@code Vertex}, false
otherwise
*/
public boolean hasWeight( 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 c6ea571..1b4c11e 100644
---
a/src/main/java/org/apache/commons/graph/spanning/SpanningTreeAlgorithmSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/SpanningTreeAlgorithmSelector.java
@@ -36,7 +36,7 @@ public interface SpanningTreeAlgorithmSelector<V, W, WE>
* Applies the <a
href="https://en.wikipedia.org/wiki/Bor%C5%AFvka's_algorithm">Boruvka</a>'s
algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the class responsible for operations on weights
+ * @param weightOperations The class responsible for operations on weights
* @return The calculated spanning tree
*/
<WO extends OrderedMonoid<W>> SpanningTree<V, WE, W>
applyingBoruvkaAlgorithm( WO weightOperations );
@@ -45,7 +45,7 @@ public interface SpanningTreeAlgorithmSelector<V, W, WE>
* Applies the <a
href="https://en.wikipedia.org/wiki/Kruskal%27s_algorithm";>Kruskal</a>'s
algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the class responsible for operations on weights
+ * @param weightOperations The class responsible for operations on weights
* @return The calculated spanning tree
*/
<WO extends OrderedMonoid<W>> SpanningTree<V, WE, W>
applyingKruskalAlgorithm( WO weightOperations );
@@ -54,7 +54,7 @@ public interface SpanningTreeAlgorithmSelector<V, W, WE>
* Applies the <a
href="https://en.wikipedia.org/wiki/Prim%27s_algorithm";>Prim</a>'s algorithm.
*
* @param <WO> the type of weight operations
- * @param weightOperations the class responsible for operations on weights
+ * @param weightOperations The class responsible for operations on weights
* @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 b4cdece..56ca0af 100644
---
a/src/main/java/org/apache/commons/graph/spanning/SpanningTreeSourceSelector.java
+++
b/src/main/java/org/apache/commons/graph/spanning/SpanningTreeSourceSelector.java
@@ -49,7 +49,7 @@ public interface SpanningTreeSourceSelector<V, W, WE>
* </pre>
*
* @param <WO> the type of weight operations
- * @param weightOperations the weight operations
+ * @param weightOperations The weight operations
* @return The calculated spanning tree
*/
<WO extends OrderedMonoid<W>> SpanningTree<V, WE, W>
applyingReverseDeleteAlgorithm( WO weightOperations );
@@ -64,7 +64,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.
+ * @param source The source vertex to calculate the spanning tree.
* @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 accdfda..737282e 100644
--- a/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
+++ b/src/main/java/org/apache/commons/graph/spanning/SuperVertex.java
@@ -54,9 +54,9 @@ final class SuperVertex<V, W, WE>
* Create a new {@link SuperVertex} instance with <code>source</code>
* as start vertex.
*
- * @param source the start vertex
- * @param graph the underlying graph
- * @param weightComparator the comparator used to sort the weighted edges
+ * @param source The start vertex
+ * @param graph The underlying graph
+ * @param weightComparator The comparator used to sort the weighted edges
*/
public SuperVertex( final V source, final Graph<V, WE> graph, final
WeightedEdgesComparator<W, WE> weightComparator )
{
@@ -108,7 +108,7 @@ final class SuperVertex<V, W, WE>
* The edges from the other {@link SuperVertex} are only added in case
* they are not to vertices already contained in this {@link SuperVertex}.
*
- * @param other the {@link SuperVertex} to be merged into this
+ * @param other The {@link SuperVertex} to be merged into this
*/
public void merge( final SuperVertex<V, W, WE> other )
{
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 17b9de8..5944ece 100644
--- a/src/main/java/org/apache/commons/graph/utils/Assertions.java
+++ b/src/main/java/org/apache/commons/graph/utils/Assertions.java
@@ -31,14 +31,14 @@ public final class Assertions
* Ensures the truth of an expression involving one or more parameters to
the
* calling method.
*
- * @param expression a boolean expression
- * @param errorMessageTemplate a template for the exception message should
the
+ * @param expression A boolean expression
+ * @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
* position - the first {@code %s} gets {@code errorMessageArgs[0]},
etc.
* Unmatched arguments will be appended to the formatted message in
square
* braces. Unmatched placeholders will be left as-is.
- * @param errorMessageArgs the arguments to be substituted into the message
+ * @param errorMessageArgs The arguments to be substituted into the message
* template. Arguments are converted to strings using
* {@link String#valueOf(Object)}.
* @throws IllegalArgumentException if {@code expression} is false
@@ -58,15 +58,15 @@ public final class Assertions
* Ensures that an object reference passed as a parameter to the calling
* method is not null.
*
- * @param reference an object reference
+ * @param reference An object reference
* @param <T> The reference type
- * @param errorMessageTemplate a template for the exception message should
the
+ * @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
* position - the first {@code %s} gets {@code errorMessageArgs[0]},
etc.
* Unmatched arguments will be appended to the formatted message in
square
* braces. Unmatched placeholders will be left as-is.
- * @param errorMessageArgs the arguments to be substituted into the message
+ * @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
@@ -86,14 +86,14 @@ public final class Assertions
* Ensures the truth of an expression involving the state of the calling
* instance, but not involving any parameters to the calling method.
*
- * @param expression a boolean expression
- * @param errorMessageTemplate a template for the exception message should
the
+ * @param expression A boolean expression
+ * @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
* position - the first {@code %s} gets {@code errorMessageArgs[0]},
etc.
* Unmatched arguments will be appended to the formatted message in
square
* braces. Unmatched placeholders will be left as-is.
- * @param errorMessageArgs the arguments to be substituted into the
message template.
+ * @param errorMessageArgs The arguments to be substituted into the
message template.
* @throws IllegalStateException if {@code expression} is false
* @throws NullPointerException if the check fails and either {@code
* errorMessageTemplate} or {@code errorMessageArgs} is null (don't let
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 dfede5f..b46eb55 100644
--- a/src/main/java/org/apache/commons/graph/utils/Objects.java
+++ b/src/main/java/org/apache/commons/graph/utils/Objects.java
@@ -28,8 +28,8 @@ public final class Objects
/**
* Verifies input objects are equal.
*
- * @param o1 the first argument to compare
- * @param o2 the second argument to compare
+ * @param o1 The first argument to compare
+ * @param o2 The second argument to compare
* @return true, if the input arguments are equal, false otherwise.
*/
public static <O> boolean eq( O o1, O o2 )
@@ -40,9 +40,9 @@ public final class Objects
/**
* Computes a hashCode given the input 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.
+ * @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.
*/
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 3fda5a1..6c26458 100644
---
a/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
+++
b/src/main/java/org/apache/commons/graph/visit/DefaultVisitAlgorithmsSelector.java
@@ -52,8 +52,8 @@ final class DefaultVisitAlgorithmsSelector<V, E, G extends
Graph<V, E>>
/**
* Create a default {@link VisitAlgorithmsSelector} for the given {@link
Graph} and start vertex.
*
- * @param graph the {@link Graph} to be used.
- * @param source the start vertex.
+ * @param graph The {@link Graph} to be used.
+ * @param source The start vertex.
*/
public DefaultVisitAlgorithmsSelector( final G graph, final V source )
{
@@ -101,7 +101,7 @@ final class DefaultVisitAlgorithmsSelector<V, E, G extends
Graph<V, E>>
* <li>Stack (LIFO): depth-first</li>
* </ul>
*
- * @param handler the handler intercepts visits
+ * @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()}
*/
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 e616144..a914160 100644
--- a/src/main/java/org/apache/commons/graph/visit/VisitAlgorithmsSelector.java
+++ b/src/main/java/org/apache/commons/graph/visit/VisitAlgorithmsSelector.java
@@ -41,7 +41,7 @@ public interface VisitAlgorithmsSelector<V, E, G extends
Graph<V, E>>
/**
* Breadth-first search algorithm implementation.
*
- * @param handler the handler intercepts visit actions
+ * @param handler The handler intercepts visit actions
*/
<O> O applyingBreadthFirstSearch( GraphVisitHandler<V, E, G, O> handler );
@@ -55,7 +55,7 @@ public interface VisitAlgorithmsSelector<V, E, G extends
Graph<V, E>>
/**
* Depth-first search algorithm implementation.
*
- * @param handler the handler intercepts visit actions
+ * @param handler The handler intercepts visit actions
*/
<O> O applyingDepthFirstSearch( GraphVisitHandler<V, E, G, O> handler );
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 2c076d9..91f24df 100644
--- a/src/main/java/org/apache/commons/graph/visit/VisitSourceSelector.java
+++ b/src/main/java/org/apache/commons/graph/visit/VisitSourceSelector.java
@@ -34,7 +34,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
+ * @param source The root node the search begins from
* @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 599ce4a..537ea4e 100644
--- a/src/main/java/org/apache/commons/graph/weight/Monoid.java
+++ b/src/main/java/org/apache/commons/graph/weight/Monoid.java
@@ -34,8 +34,8 @@ public interface Monoid<E>
* Returns the result of the associative binary operation defined by this
* {@link Semigroup} between two elements of appropriate type.
*
- * @param e1 the first element
- * @param e2 the second element
+ * @param e1 The first element
+ * @param e2 The second element
* @return The result of the associative binary operation
*/
E append( E e1, E e2 );
@@ -50,7 +50,7 @@ public interface Monoid<E>
/**
* Returns the inverse of the input element.
*
- * @param element the input element
+ * @param element The input element
* @return The inverse of the input element
*/
E inverse( E element );
