cleanup and javadoc for remaining files in onos.core.intent.runtime
Change-Id: I04567ba3b2e70bb3f72da5a863306efe1a6063b6
diff --git a/src/main/java/net/onrc/onos/core/intent/runtime/PathCalcRuntime.java b/src/main/java/net/onrc/onos/core/intent/runtime/PathCalcRuntime.java
index e1b95e2..03e23c5 100644
--- a/src/main/java/net/onrc/onos/core/intent/runtime/PathCalcRuntime.java
+++ b/src/main/java/net/onrc/onos/core/intent/runtime/PathCalcRuntime.java
@@ -24,18 +24,25 @@
import org.slf4j.LoggerFactory;
/**
- * @author Toshio Koide (t-koide@onlab.us)
+ * The runtime used by PathCalcRuntimeModule class.
+ * <p>
+ * It calculates shortest-path and constrained-shortest-path.
*/
public class PathCalcRuntime implements IFloodlightService {
private Topology topology;
private static final Logger log = LoggerFactory.getLogger(PathCalcRuntime.class);
+ /**
+ * Constructor.
+ *
+ * @param topology a topology object to use for the path calculation.
+ */
public PathCalcRuntime(Topology topology) {
this.topology = topology;
}
/**
- * calculate shortest-path and constrained-shortest-path intents into low-level path intents.
+ * Calculates shortest-path and constrained-shortest-path intents into low-level path intents.
*
* @param intentOpList IntentOperationList having instances of ShortestPathIntent/ConstrainedShortestPathIntent
* @param pathIntents a set of current low-level intents