From: guillaume.lambert
Date: Thu, 6 Jun 2019 13:14:26 +0000 (+0200)
Subject: fix javadocs warnings
X-Git-Tag: 0.4.0~73
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F21%2F82421%2F1;p=transportpce.git
fix javadocs warnings
Change-Id: I1d53db7fcb1fd93b2f0f9eb18bf10210b11ff463
Signed-off-by: guillaume.lambert
---
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 1216452b1..473958d5c 100644
--- 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
+ * 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
+ * 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 30c39d45a..4eebda105 100644
--- 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 f2c10a297..e6b236010 100644
--- 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 {
*
*
* @param nodeId node ID
- *
* @param ifBuilder Builder object containing the data to post.
+ * @param generic
*
* @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
*
@@ -54,6 +54,8 @@ public interface OpenRoadmInterfaces {
*
* @param interfaceName
* Name of the interface
+ * @param
+ * 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 09a797d17..6034bd903 100644
--- 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 d5eec885c..819783d90 100644
--- 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 9f6d307bf..df6dced55 100644
--- 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 789ecdb67..66a0b5c53 100644
--- 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 4aade1967..75b1c4892 100644
--- 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 fce4f8ef9..1337fbea4 100644
--- 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 a540f6e62..7b59eaf5b 100644
--- 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 cd8f1fef2..f422cb85a 100644
--- 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.
*/