aboutsummaryrefslogtreecommitdiffstats
path: root/services/services-engine/src
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@ericsson.com>2018-09-05 15:46:31 +0100
committerliamfallon <liam.fallon@ericsson.com>2018-09-06 13:26:24 +0100
commita41c877a6b1980e0e866699633e0289d9a3fdbb5 (patch)
tree4f8d15559549760c2e74880871ec08c3b8df2d0e /services/services-engine/src
parent825ae627d4378c5cc7ab4b7d5f4b4ffefcb7977e (diff)
Fix package of apex examples and documents
The examples are not packaged correctly in the apex build and the client wars are missing The links and location of the documents are corrected. Some POM duplicate dependencies removed. Javadoc warnings removed. Issue-ID: POLICY-867 Change-Id: I555c29191c61c0a9887365d95005dbc584eddf04 Signed-off-by: liamfallon <liam.fallon@ericsson.com>
Diffstat (limited to 'services/services-engine/src')
-rw-r--r--services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/package-info.java8
-rw-r--r--services/services-engine/src/main/java/org/onap/policy/apex/service/engine/runtime/package-info.java6
-rw-r--r--services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java2
-rw-r--r--services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/package-info.java7
4 files changed, 10 insertions, 13 deletions
diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/package-info.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/package-info.java
index 75404137e..deb502ac1 100644
--- a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/package-info.java
+++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/package-info.java
@@ -19,10 +19,10 @@
*/
/**
- * Provides a generic externally-facing {@link ApexEvent} class that can be sent into an APEX engine
- * and processed by an APEX engine. It provides the producer {@link ApexEventProducer} producer and
- * {@link ApexEventConsumer} consumer interfaces that APEX uses to send events to and receive events
- * from other systems. It also provides the {@link ApexEventConverter} interface that can be
+ * Provides a generic externally-facing ApexEvent class that can be sent into an APEX engine
+ * and processed by an APEX engine. It provides the producer ApexEventProducer producer and
+ * ApexEventConsumer consumer interfaces that APEX uses to send events to and receive events
+ * from other systems. It also provides the ApexEventConverter interface that can be
* implemented by plugins that wish to convert some external event format into the APEX event
* format. It also provides a periodic event generator that can be used to send periodic events into
* an APEX engine for triggering of policies to carry out housekeeping tasks.
diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/runtime/package-info.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/runtime/package-info.java
index b54a90349..eeb2eab0f 100644
--- a/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/runtime/package-info.java
+++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/runtime/package-info.java
@@ -19,9 +19,9 @@
*/
/**
- * Provides Java APIs for APEX engines at runtime. The {@link EngineService} is used to start, stop
- * and manage APEX engines. {@link EngineServiceEventInterface} is used to send events to an APEX
- * engine. {@link ApexEventListener} interface is used to receive events from an APEX engine.
+ * Provides Java APIs for APEX engines at runtime. The EngineService is used to start, stop
+ * and manage APEX engines. EngineServiceEventInterface is used to send events to an APEX
+ * engine. ApexEventListener interface is used to receive events from an APEX engine.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java
index 0c10df706..41e30188b 100644
--- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java
+++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/carriertechnology/CarrierTechnologyParameters.java
@@ -54,8 +54,6 @@ public abstract class CarrierTechnologyParameters implements ParameterGroup {
/**
* Constructor to create a carrier technology parameters instance with the name of a sub class of this class and
* register the instance with the parameter service.
- *
- * @param parameterClassName the class name of a sub class of this class
*/
public CarrierTechnologyParameters() {
super();
diff --git a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/package-info.java b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/package-info.java
index 2c6473776..e9e8923d0 100644
--- a/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/package-info.java
+++ b/services/services-engine/src/main/java/org/onap/policy/apex/service/parameters/package-info.java
@@ -19,10 +19,9 @@
*/
/**
- * Implements parameter handling for all parameters in APEX. It uses specializations of (@link
- * {@link org.onap.policy.apex.model.basicmodel.service.AbstractParameters} for all parameters and
- * works with {@link org.onap.policy.apex.model.basicmodel.service.ParameterService} for storing and
- * finding parameters.
+ * Implements parameter handling for all parameters in APEX.
+ * It uses specializations of the class <code>AbstractParameters</code> (basic model) for all parameters.
+ * It works with <code>ParameterService</code> (basic model) for storing and finding parameters.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/