fix javadoc warnings 11/78411/4
authorguillaume.lambert <guillaume.lambert@orange.com>
Tue, 4 Dec 2018 09:35:36 +0000 (10:35 +0100)
committerGuillaume Lambert <guillaume.lambert@orange.com>
Tue, 4 Dec 2018 14:10:04 +0000 (14:10 +0000)
Change-Id: If1c1a715e517ce9e431b0c693bebce3207982be8
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/ClliNetwork.java
networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/LinkIdUtil.java
networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/OpenRoadmNetwork.java
networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/OpenRoadmTopology.java
renderer/src/main/java/org/opendaylight/transportpce/renderer/provisiondevice/DeviceRendererService.java
tests/stubpce/src/main/java/org/opendaylight/transportpce/stubpce/topology/SuperNodePath.java

index 0379442620228deeaeff71d5c9dca630db9d6b2a..f891ca50903cd46dff89e36d7ac7acfa942ae847 100644 (file)
@@ -49,6 +49,8 @@ public final class ClliNetwork {
 
     /**
      * This public method creates the CLLI Layer and posts it to the controller.
+     *
+     * @param controllerdb   controller Databroker
      */
     public static void createClliLayer(DataBroker controllerdb) {
         try {
@@ -67,6 +69,10 @@ public final class ClliNetwork {
     /**
      * Create single node entry for CLLI topology.
      *
+     * @param deviceTransactionManager device transation manager
+     * @param deviceId device ID
+     *
+     * @return node builder status
      */
     public static Node createNode(DeviceTransactionManager deviceTransactionManager, String deviceId) {
         //Read clli from the device
index d8e037ac0f734e4af8d4d3a0df7694785bc451a6..371bdf5bf928384b194d3c30b56ece8b8082d765 100644 (file)
@@ -75,6 +75,8 @@ public final class LinkIdUtil {
      * @param srcTp a source termination point
      * @param destNode a destination node
      * @param destTp a destination termination point
+     * @param checkNode boolean to check node
+     *
      * @return LinkId a link identifier
      */
     public static LinkId getOppositeLinkId(String srcNode, String srcTp, String destNode, String destTp,
index df6f824be97d70ad6b90fc5516c3f519cbc72424..22dedb9a578ad0e4e5c9f0926991041cf23a38fe 100644 (file)
@@ -56,6 +56,8 @@ public final class OpenRoadmNetwork {
     /**
      * This public method creates the OpenRoadmNetwork Layer and posts it to the
      * controller.
+     *
+     * @param controllerdb controller databroker
      */
     public static void createOpenRoadmNetworkLayer(DataBroker controllerdb) {
         try {
@@ -74,6 +76,10 @@ public final class OpenRoadmNetwork {
     /**
      * Create single node entry for OpenRoadmNetwork.
      *
+     * @param nodeId node ID
+     * @param deviceTransactionManager device transaction manager
+     *
+     * @return node builder status
      */
     public static Node createNode(String nodeId, DeviceTransactionManager deviceTransactionManager) {
         // Fetches the info from the deviceInfo
index acb36c915bf3a602f9a4b14f5615be53edbb091f..c89fd5a65737381a0279b3606f0bac5a4d359e4e 100644 (file)
@@ -101,6 +101,8 @@ public class OpenRoadmTopology {
     /**
      * This public method creates the OpenROADM Topology Layer and posts it to
      * the controller.
+     *
+     * @param controllerdb controller databroker
      */
     public void createTopoLayer(DataBroker controllerdb) {
         try {
index 6fb01df07b4997d6ecc7c7de1bafcfb790255e7b..53bb7c4c2183d2bab4a164d0897bfd26c2330a13 100644 (file)
@@ -36,6 +36,8 @@ public interface DeviceRendererService {
      *
      * @param input
      *            Input parameter from the service-path yang model
+     * @param direction
+     *            Service Path direction
      *
      * @return Result list of all nodes if request successful otherwise specific
      *         reason of failure.
index 55bfa81af55af69978635006091434e181bc9185..e96eb5c4550009f9b9ed18a8ebd17cbb5fc47858 100644 (file)
@@ -564,7 +564,7 @@ public class SuperNodePath {
      *
      * @param aend beginning extremity path
      * @param zend ending extremity path
-     * @param paths NodeLinkNode list paths
+     * @param nodeLinkNodes list paths
      * @return PathDescriptionsOrdered List of direct paths
      */
     public SortedSet<PathDescriptionsOrdered> getDirectPathDesc(String aend, String zend,
@@ -628,7 +628,7 @@ public class SuperNodePath {
      *
      * @param aend beginning extremity path
      * @param zend ending extremity path
-     * @param paths NodeLinkNode list paths
+     * @param nodeLinkNodes list paths
      * @return PathDescriptionsOrdered List of indirect paths
      */
     public SortedSet<PathDescriptionsOrdered> getIndirectPathDesc(String aend, String zend,