fix javadocs warnings

Change-Id: I1d53db7fcb1fd93b2f0f9eb18bf10210b11ff463
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>

diff --git a/common/src/main/java/org/opendaylight/transportpce/common/crossconnect/CrossConnect.java b/common/src/main/java/org/opendaylight/transportpce/common/crossconnect/CrossConnect.java
index 1216452b1c4d1f9cb1d405b66ca4738760bcdda0..473958d5c1a9e5bc952e449e76722b6ad7f6b7e3 100644 (file)
--- a/common/src/main/java/org/opendaylight/transportpce/common/crossconnect/CrossConnect.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/crossconnect/CrossConnect.java
@@ -23,6 +23,8 @@ public interface CrossConnect {
      *            Device id.
      * @param connectionNumber
      *            Name of the cross connect.
+     * @param <T>
+     *            generic.
      *
      * @return Roadm connection subtree from the device.
      */
@@ -71,6 +73,10 @@ public interface CrossConnect {
      *            Source logical connection point.
      * @param destTp
      *            Destination logical connection point.
+     * @param <T>
+     *            generic.
+     * @throws OpenRoadmInterfaceException
+     *            an exception at OpenRoadm interface.
      *
      * @return list of Ports object type.
      */

diff --git a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMapping.java b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMapping.java
index 30c39d45a934aa77363b7b331d3d2079a0643b67..4eebda105ceec33e03d7b9b3db8000c52b6230d9 100644 (file)
--- a/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMapping.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMapping.java
@@ -39,6 +39,8 @@ public interface PortMapping {
      *
      * @param nodeId
      *            node ID
+     * @param nodeVersion
+     *            node version
      *
      * @return true/false based on status of operation
      */

diff --git a/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java b/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java
index f2c10a2978176ea473776cc5b64015463a1fe41e..e6b236010917aaee1dea024a1831f88e3bcaa90b 100644 (file)
--- a/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java
@@ -23,8 +23,8 @@ public interface OpenRoadmInterfaces {
      * </p>
      *
      * @param nodeId node ID
-     *
      * @param ifBuilder Builder object containing the data to post.
+     * @param <T> generic
      *
      * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
      *
@@ -54,6 +54,8 @@ public interface OpenRoadmInterfaces {
      *
      * @param interfaceName
      *            Name of the interface
+     * @param <T>
+     *            generic
      *
      * @return Optional of Interface from datastore
      *

diff --git a/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/ClliNetwork.java b/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/ClliNetwork.java
index 09a797d1769416368e81d04097a7db8b6e927501..6034bd9033a2030907bb4d7f6e0d47d34f3e2e8b 100644 (file)
--- a/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/ClliNetwork.java
+++ b/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/ClliNetwork.java
@@ -68,6 +68,7 @@ public final class ClliNetwork {
      *
      * @param deviceTransactionManager device transation manager
      * @param deviceId device ID
+     * @param openRoadmVersion OpenRoadm Version number
      *
      * @return node builder status
      */

diff --git a/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/OpenRoadmNetwork.java b/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/OpenRoadmNetwork.java
index d5eec885c20247fa50043e8ad532ef4521a5eb90..819783d90483810c80a18d6e10dfc5292ef011fb 100644 (file)
--- a/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/OpenRoadmNetwork.java
+++ b/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/OpenRoadmNetwork.java
@@ -76,6 +76,7 @@ public final class OpenRoadmNetwork {
      *
      * @param nodeId node ID
      * @param deviceTransactionManager device transaction manager
+     * @param openRoadmVersion OpenRoadm version number
      *
      * @return node builder status
      */

diff --git a/olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion121.java b/olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion121.java
index 9f6d307bfb66b2d0f61e9ce3fa5cc05702364d06..df6dced557a1236a566c6f96c0d125de2b0d9a40 100644 (file)
--- a/olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion121.java
+++ b/olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion121.java
@@ -141,6 +141,11 @@ public final class PowerMgmtVersion121 {
      *            OCH interface name carrying WL
      * @param txPower
      *            Calculated transmit power
+     * @param interfaceObj
+     *            Interface object
+     * @param deviceTransactionManager
+     *            Device Transaction Manager
+     *
      * @return true/false based on status of operation
      */
     public static boolean setTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
@@ -202,6 +207,11 @@ public final class PowerMgmtVersion121 {
      *            Power value in DBm.
      * @param connectionNumber
      *            Name of the cross connect.
+     * @param crossConnect
+     *            cross connect.
+     * @param deviceTransactionManager
+     *            Device Transaction Manager.
+     *
      * @return true/false based on status of operation.
      */
     public static boolean setPowerLevel(String deviceId, OpticalControlMode mode, BigDecimal powerValue,

diff --git a/olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion221.java b/olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion221.java
index 789ecdb671c0bfed6f87f9421241615ffb031a96..66a0b5c530451f46a79dd9eaf2e97e0be1e2681a 100644 (file)
--- a/olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion221.java
+++ b/olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmtVersion221.java
@@ -143,6 +143,11 @@ public final class PowerMgmtVersion221 {
      *            OCH interface name carrying WL
      * @param txPower
      *            Calculated transmit power
+     * @param deviceTransactionManager
+     *            Device Transaction Manager
+     * @param interfaceObj
+     *            Interface object
+     *
      * @return true/false based on status of operation
      */
     public static boolean setTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
@@ -201,6 +206,11 @@ public final class PowerMgmtVersion221 {
      *            Power value in DBm.
      * @param connectionNumber
      *            Name of the cross connect.
+     * @param crossConnect
+     *            cross connect.
+     * @param deviceTransactionManager
+     *            Device Transaction Manager.
+     *
      * @return true/false based on status of operation.
      */
     public static boolean setPowerLevel(String deviceId, OpticalControlMode mode, BigDecimal powerValue,

diff --git a/olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java b/olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java
index 4aade196763410ef882b65bb76ef51bfdf1ecaa7..75b1c489218acf0a1041b1a3c4530458958d3651 100644 (file)
--- a/olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java
+++ b/olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java
@@ -74,6 +74,8 @@ public final class OlmUtils {
      *            Input parameter from the olm yang model get-pm rpc
      * @param deviceTransactionManager
      *            Device tx manager
+     * @param openRoadmVersion
+     *            OpenRoadm version number
      *
      * @return Result of the request list of PM readings
      */

diff --git a/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface121.java b/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface121.java
index fce4f8ef92b287de26d4ae4fd3137704c114511a..1337fbea4e146e79a03f9a922d6503166b84bde1 100644 (file)
--- a/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface121.java
+++ b/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface121.java
@@ -203,7 +203,11 @@ public class OpenRoadmInterface121 {
      * This methods creates an OCH interface on the given termination point on
      * Roadm.
      *
+     * @param nodeId node ID
+     * @param logicalConnPoint logical connection point
      * @param waveNumber wavelength number of the OCH interface.
+     * @throws OpenRoadmInterfaceException OpenRoadm interface exception
+     *
      * @return Name of the interface if successful, otherwise return null.
      */
 

diff --git a/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface221.java b/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface221.java
index a540f6e62c91bd95eb18fc0982e0054ca86aa710..7b59eaf5b7de60c48adee37ea1dfb6feb4eca26b 100644 (file)
--- a/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface221.java
+++ b/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface221.java
@@ -110,7 +110,11 @@ public class OpenRoadmInterface221 {
      * This methods creates an OCH interface on the given termination point on
      * Roadm.
      *
+     * @param nodeId node ID
+     * @param logicalConnPoint logical connection point
      * @param waveNumber wavelength number of the OCH interface.
+     * @throws OpenRoadmInterfaceException OpenRoadm interface exception
+     *
      * @return Name of the interface if successful, otherwise return null.
      */
 

diff --git a/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.java b/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.java
index cd8f1fef2c48cfc3f5f25bf6f5faf41762642412..f422cb85ab193fb1e9965ad0a9a1e8a979091c6a 100644 (file)
--- a/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.java
+++ b/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.java
@@ -50,7 +50,11 @@ public class OpenRoadmInterfaceFactory {
      * This methods creates an OCH interface on the given termination point on
      * Roadm.
      *
+     * @param nodeId node ID
+     * @param logicalConnPoint logical connection point
      * @param waveNumber wavelength number of the OCH interface.
+     * @throws OpenRoadmInterfaceException OpenRoadm interface exception
+     *
      * @return Name of the interface if successful, otherwise return null.
      */
 
@@ -84,6 +88,11 @@ public class OpenRoadmInterfaceFactory {
     /**
      * This methods creates an ODU interface on the given termination point.
      *
+     * @param nodeId node ID
+     * @param logicalConnPoint logical connection point
+     * @param supportingOtuInterface supporting OTU interface
+     * @throws OpenRoadmInterfaceException OpenRoadm interface exception
+     *
      * @return Name of the interface if successful, otherwise return null.
      */
 
@@ -104,6 +113,11 @@ public class OpenRoadmInterfaceFactory {
     /**
      * This methods creates an OTU interface on the given termination point.
      *
+     * @param nodeId node ID
+     * @param logicalConnPoint logical connection point
+     * @param supportOchInterface supporting OCH interface
+     * @throws OpenRoadmInterfaceException OpenRoadm interface exception
+     *
      * @return Name of the interface if successful, otherwise return null.
      */