From eabe3318588f0132c0977ae98f8659950c719609 Mon Sep 17 00:00:00 2001
From: "guillaume.lambert"
Date: Fri, 6 Jul 2018 15:58:49 +0200
Subject: [PATCH] fix javadocs build errors
Change-Id: I2b3dc5e496fc853f4bfdca948a1acd96fb288afd
Signed-off-by: guillaume.lambert
---
.../common/crossconnect/CrossConnect.java | 2 ++
.../common/device/DeviceTransactionManager.java | 2 +-
.../transportpce/common/mapping/PortMapping.java | 6 ++++++
.../openroadminterfaces/OpenRoadmInterfaces.java | 12 ++++++++++++
4 files changed, 21 insertions(+), 1 deletion(-)
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 45a244043..0b708c006 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
@@ -73,6 +73,8 @@ public interface CrossConnect {
* Source logical connection point.
* @param destTp
* Destination logical connection point.
+ * @throws OpenRoadmInterfaceException
+ * OpenRoadm Interface Exception.
*
* @return list of Ports object type.
*/
diff --git a/common/src/main/java/org/opendaylight/transportpce/common/device/DeviceTransactionManager.java b/common/src/main/java/org/opendaylight/transportpce/common/device/DeviceTransactionManager.java
index 20371356f..68ad62d87 100644
--- a/common/src/main/java/org/opendaylight/transportpce/common/device/DeviceTransactionManager.java
+++ b/common/src/main/java/org/opendaylight/transportpce/common/device/DeviceTransactionManager.java
@@ -70,6 +70,7 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
*
*
* Bellow is simple example how to get {@link DeviceTransaction}, put some data to it and then submit it.
+ *
*
* {@code
* // get device transaction future from device transaction manager
@@ -103,7 +104,6 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
* }
* }
*
- *
*/
public interface DeviceTransactionManager {
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 ccbd13547..491692c05 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
@@ -36,6 +36,9 @@ public interface PortMapping {
* successful the mapping gets stored in datastore corresponding to
* portmapping.yang data model.
*
+ * @param nodeId
+ * node ID
+ *
* @return true/false based on status of operation
*/
boolean createMappingData(String nodeId);
@@ -43,6 +46,9 @@ public interface PortMapping {
/**
* This method removes mapping data from the datastore after disconnecting
* ODL from a Netconf device.
+ *
+ * @param nodeId
+ * node ID
*/
void deleteMappingData(String nodeId);
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 b553a422f..3cec88f63 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
@@ -25,8 +25,12 @@ public interface OpenRoadmInterfaces {
* 2. If exists then admin state of interface is outOfState/Maintenance
*
*
+ * @param nodeId node ID
+ *
* @param ifBuilder Builder object containing the data to post.
*
+ * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
+ *
*/
void postInterface(String nodeId, InterfaceBuilder ifBuilder) throws OpenRoadmInterfaceException;
@@ -35,9 +39,13 @@ public interface OpenRoadmInterfaces {
* interface name as the key and return the class corresponding to the interface
* type.
*
+ * @param nodeId node ID
+ *
* @param interfaceName
* Name of the interface
*
+ * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
+ *
* @return Optional of Interface from datastore
*/
Optional getInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException;
@@ -52,8 +60,12 @@ public interface OpenRoadmInterfaces {
* 2. If exists then changes the state of interface to outOfService
*
*
+ * @param nodeId node ID
+ *
* @param interfaceName
* Name of the interface to delete.
+ *
+ * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
*/
void deleteInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException;
--
2.36.6