fix javadocs build errors 92/74092/1
authorguillaume.lambert <guillaume.lambert@orange.com>
Fri, 6 Jul 2018 13:58:49 +0000 (15:58 +0200)
committerguillaume.lambert <guillaume.lambert@orange.com>
Mon, 16 Jul 2018 21:18:53 +0000 (23:18 +0200)
Change-Id: I2b3dc5e496fc853f4bfdca948a1acd96fb288afd
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
common/src/main/java/org/opendaylight/transportpce/common/crossconnect/CrossConnect.java
common/src/main/java/org/opendaylight/transportpce/common/device/DeviceTransactionManager.java
common/src/main/java/org/opendaylight/transportpce/common/mapping/PortMapping.java
common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java

index 45a24404346264cac48354e931a76eb6b786d17e..0b708c00670d55d0828597762417a873a1e9a44e 100644 (file)
@@ -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.
      */
index 20371356f88f2652e39941dbf33aadc2ec19a4d6..68ad62d87eec1e4ae312803230ba059caaabdba2 100644 (file)
@@ -70,6 +70,7 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  *
  * <p>
  * Bellow is simple example how to get {@link DeviceTransaction}, put some data to it and then submit it.
+ * </p>
  * <pre>
  * {@code
  *     // get device transaction future from device transaction manager
@@ -103,7 +104,6 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  *     }
  * }
  * </pre>
- * </p>
  */
 public interface DeviceTransactionManager {
 
index ccbd13547253c9036e1c99fdd8fde85fbd653eb8..491692c05369dae86dee08d4c6174df89f89579e 100644 (file)
@@ -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);
 
index b553a422f2622c7ad1c6a231bc5760e55fb746f2..3cec88f635fc97faf6b75911fbe9598fbec84301 100644 (file)
@@ -25,8 +25,12 @@ public interface OpenRoadmInterfaces {
      * 2. If exists then admin state of interface is outOfState/Maintenance
      * </p>
      *
+     * @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<Interface> 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
      * </p>
      *
+     * @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;