1 files changed, 22 insertions, 14 deletions

diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/PathService.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/PathService.java
index 0bd4d75d..38954079 100644
--- a/framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/PathService.java
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/PathService.java
@@ -30,8 +30,9 @@ import java.util.Set;
 public interface PathService {
 
     /**
-     * Returns the set of all shortest paths, precomputed in terms of hop-count,
-     * between the specified source and destination elements.
+     * Returns the set of all shortest paths between the specified source and
+     * destination elements. The path is computed using the default edge-weight
+     * function, which by default is hop-count.
      *
      * @param src source element
      * @param dst destination element
@@ -40,9 +41,9 @@ public interface PathService {
     Set<Path> getPaths(ElementId src, ElementId dst);
 
     /**
-     * Returns the set of all shortest paths, computed using the supplied
-     * edge-weight entity, between the specified source and destination
-     * network elements.
+     * Returns the set of all shortest paths between the specified source and
+     * destination network elements.  The path is computed using the supplied
+     * edge-weight function.
      *
      * @param src    source element
      * @param dst    destination element
@@ -52,8 +53,9 @@ public interface PathService {
     Set<Path> getPaths(ElementId src, ElementId dst, LinkWeight weight);
 
     /**
-     * Returns the set of all disjoint shortest path pairs, precomputed in terms of hop-count,
-     * between the specified source and destination devices.
+     * Returns the set of all disjoint shortest path pairs between the
+     * specified source and destination elements. The path is computed using
+     * the default edge-weight function, which by default is hop-count.
      *
      * @param src source device
      * @param dst destination device
@@ -62,8 +64,9 @@ public interface PathService {
     Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst);
 
     /**
-     * Returns the set of all disjoint shortest path pairs, computed using the supplied
-     * edge-weight entity, between the specified source and destination devices.
+     * Returns the set of all disjoint shortest path pairs between the
+     * specified source and destination elements. The path is computed using
+     * the supplied edge-weight function.
      *
      * @param src    source device
      * @param dst    destination device
@@ -74,8 +77,10 @@ public interface PathService {
                                        LinkWeight weight);
 
     /**
-     * Returns the set of all disjoint shortest path pairs, precomputed in terms of hop-count,
-     * between the specified source and destination devices.
+     * Returns the set of all disjoint shortest path pairs between the
+     * specified source and destination elements and taking into consideration
+     * the provided risk profile. The path is computed using the default
+     * edge-weight function, which by default is hop-count.
      *
      * @param src         source device
      * @param dst         destination device
@@ -86,8 +91,10 @@ public interface PathService {
                                        Map<Link, Object> riskProfile);
 
     /**
-     * Returns the set of all disjoint shortest path pairs, precomputed in terms of hop-count,
-     * between the specified source and destination devices.
+     * Returns the set of all disjoint shortest path pairs between the
+     * specified source and destination elements and taking into consideration
+     * the provided risk profile. The path is computed using the supplied
+     * edge-weight function.
      *
      * @param src         source device
      * @param dst         destination device
@@ -96,6 +103,7 @@ public interface PathService {
      * @return set of all shortest paths between the two devices
      */
     Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst,
-                                       LinkWeight weight, Map<Link, Object> riskProfile);
+                                       LinkWeight weight,
+                                       Map<Link, Object> riskProfile);
 
 }