fix more javadocs warnings

Change-Id: Ic03ee472e01b7d229759fb2c5fca93c44b7332b2
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
(cherry picked from commit aa5b53b863a5a699d32febadc3345baa4038a653)

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 d0bc45e9553d97c74eda18163ef21b57462f29b4..fa45f1913f300518d0272300c9a4186febdd680c 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
@@ -43,6 +43,8 @@ public interface OpenRoadmInterfaces {
      * @param nodeId node ID
      * @param circuitPackName Circtuit-Pack name
      * @param activate activate or not
+     *
+     * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
      */
     void postEquipmentState(String nodeId, String circuitPackName, boolean activate) throws OpenRoadmInterfaceException;
 

diff --git a/pce/src/test/java/org/opendaylight/transportpce/pce/PceManyTests.java b/pce/src/test/java/org/opendaylight/transportpce/pce/PceManyTests.java
index ef1e5d41910e091b40fb0b38c3bdb349d6588b4a..5575e4722c87e67e396047bfc77a05b4240ae7a5 100644 (file)
--- a/pce/src/test/java/org/opendaylight/transportpce/pce/PceManyTests.java
+++ b/pce/src/test/java/org/opendaylight/transportpce/pce/PceManyTests.java
@@ -47,6 +47,8 @@ public class PceManyTests extends AbstractTest {
      *   expected path computation result
      * @param topologyDataPath
      *   path to topology data file to be used for DataStore population
+     *
+     * @throws Exception exception throws by the function
      */
     public PceManyTests(PathComputationRequestInput input,
                         PathComputationRequestOutput expectedOutput, String topologyDataPath) throws Exception {

diff --git a/pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestData.java b/pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestData.java
index 0e1394e4f2f1c908837c9c6ba5aa085e3a310a4b..d4747a53f125d30f2e83175bd8f0feff1a116627 100644 (file)
--- a/pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestData.java
+++ b/pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestData.java
@@ -223,6 +223,8 @@ public final class PceTestData {
 
     /**
      * Generate Data for Test 1 result 5-4.
+     * @param wl WaveLength
+     *
      * @return output PathComputationRequestOutput data
      */
     public static PathComputationRequestOutput getPCE_test_result_54(Long wl) {
@@ -466,6 +468,8 @@ public final class PceTestData {
          "pce:pce-metric": "hop-count"
        }
      }</code>
+     * @param base Path Computation Request Input base
+     *
      * @return input PathComputationRequestInput data
      */
     public static PathComputationRequestInput build_diversity_from_request(PathComputationRequestInput base) {

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 734c6e5818dcba4b648e8d376b2e1eb336766e3f..5d3b2a86eedde87c858047863aff58c1a17fc031 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
@@ -219,6 +219,7 @@ public class OpenRoadmInterfaceFactory {
      *
      *
      * @return Name of the interface if successful, otherwise return null.
+     * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
      */
 
     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)

diff --git a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/CheckCoherencyHardSoft.java b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/CheckCoherencyHardSoft.java
index a9a2d80b25ff496ba3043ba902989a800e3e47cc..f3c015a0446dce3f76cbbda2fd5717599f05c738 100644 (file)
--- a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/CheckCoherencyHardSoft.java
+++ b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/CheckCoherencyHardSoft.java
@@ -23,6 +23,9 @@ public final class CheckCoherencyHardSoft {
 
     /**
      * function to check coherency between hard and soft constraints.
+     * @param hard Hard Constraints
+     * @param soft Soft Constraints
+     *
      * @return  <code> true </code>  if coherent
      *          <code> false </code> else
      */

diff --git a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerCompliancyCheck.java b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerCompliancyCheck.java
index 72995e6ba474c716161461b19b152edc4212af08..0ee2ba8f701a9d4e97a320df1cf3f0a895996af6 100644 (file)
--- a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerCompliancyCheck.java
+++ b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerCompliancyCheck.java
@@ -35,16 +35,24 @@ public final class ServicehandlerCompliancyCheck {
     /**
      * Check Compliancy of Service request.
      *
+     * @param serviceName
+     *            Service Name
+     * @param sdncRequestHeader
+     *            sdncRequestHeader
+     * @param conType
+     *            Connection type
+     * @param action
+     *            RPC Actions
      * @param contype
      *            Boolean to check connection Type
-     * @param sndcRequest
-     *            Boolean to check sndcRequestHeader
+     * @param sdncRequest
+     *            Boolean to check sdncRequestHeader
      *
      * @return true if String ok false if not
      */
     public static ComplianceCheckResult check(String serviceName, SdncRequestHeader sdncRequestHeader,
                                        ConnectionType conType, RpcActions action,
-                                       Boolean contype, Boolean sndcRequest) {
+                                       Boolean contype, Boolean sdncRequest) {
         boolean result = true;
         String message = "";
         if (!checkString(serviceName)) {
@@ -54,7 +62,7 @@ public final class ServicehandlerCompliancyCheck {
             result = false;
             message = "Service ConnectionType is not set";
         }
-        if (sndcRequest) {
+        if (sdncRequest) {
             if (sdncRequestHeader != null) {
                 RpcActions serviceAction = sdncRequestHeader.getRpcAction();
                 String requestId = sdncRequestHeader.getRequestId();

diff --git a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerTxRxCheck.java b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerTxRxCheck.java
index 367e26dc113255919d830f5a6a5292ff8441effb..e55cf5cdc7fe8cb6e7e27de797f0a305c1e3d071 100644 (file)
--- a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerTxRxCheck.java
+++ b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerTxRxCheck.java
@@ -124,6 +124,8 @@ public final class ServicehandlerTxRxCheck {
 
     /**
      * Check Compliancy of Service TxRx info.
+     * @param serviceEnd Service Endpoint
+     * @param endpointType Endpoint type
      *
      * @return true if String ok false if not
      */