Author: simonetripodi
Date: Fri Jun 17 17:12:19 2011
New Revision: 1136943
URL: http://svn.apache.org/viewvc?rev=1136943&view=rev
Log:
added missing javadoc
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/Dijkstra.java
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/Dijkstra.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/Dijkstra.java?rev=1136943&r1=1136942&r2=1136943&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/Dijkstra.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/shortestpath/Dijkstra.java
Fri Jun 17 17:12:19 2011
@@ -35,7 +35,7 @@ import org.apache.commons.graph.Weighted
import org.apache.commons.graph.model.InMemoryWeightedPath;
/**
- *
+ * Contains the Dijkstra's shortest path algorithm implementation.
*/
public final class Dijkstra
{
@@ -51,12 +51,12 @@ public final class Dijkstra
/**
* Applies the classical Dijkstra algorithm to find the shortest path from
the source to the target, if exists.
*
- * @param <V>
- * @param <WE>
- * @param graph
- * @param source
- * @param target
- * @return
+ * @param <V> the Graph vertices type.
+ * @param <WE> the Graph weighted edges type
+ * @param graph the Graph which shortest path from {@code source} to
{@code target} has to be found
+ * @param source the shortest path source Vertex
+ * @param target the shortest path target Vertex
+ * @return a path wich describes the shortes path, if any, otherwise a
{@link PathNotFoundException} will be thrown
*/
public static <V extends Vertex, WE extends WeightedEdge<V>>
WeightedPath<V, WE> findShortestPath( WeightedGraph<V, WE> graph,
V source,
