[SECIOTSRK-628] Add maven plugin for javadoc. Fix javadoc errors for generate javadoc...
authorm.dalakov <m.dalakov@samsung.com>
Thu, 5 Oct 2017 16:04:18 +0000 (19:04 +0300)
committerm.dalakov <m.dalakov@samsung.com>
Thu, 5 Oct 2017 16:04:18 +0000 (19:04 +0300)
28 files changed:
servers/commons/src/main/java/com/samsung/commons/domain/Agent.java
servers/commons/src/main/java/com/samsung/commons/domain/Device.java
servers/commons/src/main/java/com/samsung/commons/domain/Policy.java
servers/commons/src/main/java/com/samsung/commons/repository/ReportRepository.java
servers/commons/src/main/java/com/samsung/commons/service/AgentService.java
servers/commons/src/main/java/com/samsung/commons/service/CommonService.java
servers/commons/src/main/java/com/samsung/commons/service/DeviceService.java
servers/commons/src/main/java/com/samsung/commons/service/PolicyService.java
servers/commons/src/main/java/com/samsung/commons/service/UserService.java
servers/commons/src/main/java/com/samsung/commons/service/impl/UserServiceImpl.java
servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/AgentConverter.java
servers/dsm/src/main/java/com/samsung/dsm/model/restapi/converter/DeviceConverter.java
servers/dsm/src/main/java/com/samsung/dsm/report/analyzer/impl/RuleAnalyzer.java
servers/dsm/src/main/java/com/samsung/dsm/rest/accesstoken/AccessTokenApi.java
servers/mq/src/main/java/com/samsung/servermq/iotivity/KafkaErrorMessages.java
servers/mq/src/main/java/com/samsung/servermq/iotivity/Publisher.java
servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/PostDataExtractor.java
servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceRegistrationPostDataExtractor.java
servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/DeviceUnRegistrationPostDataExtractor.java
servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/PolicyPostDataExtractor.java
servers/mq/src/main/java/com/samsung/servermq/iotivity/extractor/impl/ReportPostDataExtractor.java
servers/mq/src/main/java/com/samsung/servermq/iotivity/report/PrepareReport.java
servers/mq/src/main/java/com/samsung/servermq/rest/DSMRestController.java
servers/mq/src/main/java/com/samsung/servermq/utils/Cbor.java
servers/mq/src/main/java/com/samsung/servermq/utils/MessageQueueUtils.java
servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSender.java
servers/mq/src/main/java/com/samsung/servermq/utils/rest/ServerSenderImpl.java
servers/pom.xml

index ef70b8c..6c1ea1b 100644 (file)
@@ -93,7 +93,6 @@ public class Agent implements Serializable {
      * Sets the id.
      *
      * @param id the id
-     * @return the unique identifier
      */
     public void setId(Long id) {
         this.id = id;
index d5185ec..7bd365b 100644 (file)
@@ -250,7 +250,6 @@ public class Device implements Serializable {
      * Sets the id.
      *
      * @param id the id
-     * @return the unique identifier
      */
     public void setId(Long id) {
         this.id = id;
index c820ed1..6cd266f 100644 (file)
@@ -176,7 +176,7 @@ public class Policy implements Serializable {
 
     /**
      * Checks whether objects are equal.
-     * @param object to compare with
+     * @param obj to compare with
      *
      * @return true if objects are equels, otherwise false
      */
index dbe7f4c..4ba2e04 100644 (file)
@@ -22,7 +22,6 @@ import java.util.List;
  * @author <A HREF="mailto:a.motchanyi@samsung.com">Artem Motchanyi</A>
  * @version 1.0
  * @see Report
- * @see Device
  * @since 2016 -09-01
  */
 @Repository
index d93a616..30f5128 100644 (file)
@@ -50,7 +50,6 @@ public interface AgentService extends CommonService<Agent> {
      * @param uuid unique agent id
      * @param name agent name
      * @return {@link Agent}
-     * @throws Exception the empty name exception.
      */
     Agent init(String uuid, String name);
 
@@ -61,7 +60,6 @@ public interface AgentService extends CommonService<Agent> {
      * @param name   agent name
      * @param device device to which the agent belongs
      * @return {@link Agent}
-     * @throws Exception the empty name exception.
      */
     Agent init(String uuid, String name, Device device);
 
index 264cca3..bd8732b 100644 (file)
@@ -12,7 +12,6 @@ package com.samsung.commons.service;
  * @param <T> the type parameter
  * @author <A HREF="mailto:s.shram@samsung.com">Sergiy Shram</A>
  * @version 1.0
- * @see Device
  * @since 2016 -09-01
  */
 public interface CommonService<T> {
index 8a831c1..c54958d 100644 (file)
@@ -87,7 +87,6 @@ public interface DeviceService extends CommonService<Device> {
      * @param user   user
      * @param route  the route
      * @return {@link Device}
-     * @throws Exception the empty name exception.
      */
     Device init(String uuid, String name, String type, String model, int status, User user, String route);
 
index 7ba3370..acbe1c8 100644 (file)
@@ -49,7 +49,6 @@ public interface PolicyService extends CommonService<Policy> {
      * @param deviceUuid of the device
      * @param policy     to set
      * @return {@link Policy}
-     * @throws Exception device doesn't exist exception.
      */
     Policy setDevicePolicy(String deviceUuid, String policy);
 
@@ -59,7 +58,6 @@ public interface PolicyService extends CommonService<Policy> {
      * @param agentUuid of the agent
      * @param policy    to set
      * @return {@link Policy}
-     * @throws Exception agent doesn't exist exception.
      */
     Policy setAgentPolicy(String agentUuid, String policy);
 
index 07e194f..80b5c56 100644 (file)
@@ -16,7 +16,6 @@ import java.util.List;
  *
  * @author <A HREF="mailto:s.shram@samsung.com">Sergii Shram</A>
  * @version 1.0
- * @see Role
  * @since 2016 -09-01
  */
 public interface UserService extends CommonService<User> {
@@ -68,7 +67,6 @@ public interface UserService extends CommonService<User> {
      * Service method provides user removal by ID.
      *
      * @param id of user for removal.
-     * @throws Exception self removal occurred
      */
     void remove(Long id);
 
index 88b9907..a85eb29 100644 (file)
@@ -28,7 +28,6 @@ import com.samsung.commons.service.UserService;
  *
  * @author <A HREF="mailto:s.shram@samsung.com">Sergii Shram</A>
  * @version 1.0
- * @see Role
  * @since 2016 -09-01
  */
 @Service("userService")
index 8fa396d..b8cdf8f 100644 (file)
@@ -6,7 +6,7 @@ import org.springframework.stereotype.Service;
 import com.samsung.dsm.model.restapi.RestAgent;
 
 /**
- * Agent -> RestAgent
+ * Agent - RestAgent
  *
  * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
  * @version 1.0
index 47fcdf7..f10ee8c 100644 (file)
@@ -5,7 +5,7 @@ import com.samsung.dsm.model.restapi.RestDevice;
 import org.springframework.stereotype.Service;
 
 /**
- * Device -> RestDevice
+ * Device - RestDevice
  *
  * @author <A HREF="mailto:o.abakumov@samsung.com">Oleksandr Abakumov</A>
  * @version 1.0
index 617b81a..953c53f 100644 (file)
@@ -81,6 +81,7 @@ public class RuleAnalyzer {
      * Is valid boolean.
      *
      * @param currentRow the current row
+     * @param reportType the current row
      * @return the boolean
      */
     protected boolean isValid(String currentRow, String reportType) {
index c1e2c6d..6e40b6b 100644 (file)
@@ -65,7 +65,7 @@ public class AccessTokenApi {
 
     /**
      * Get information about the user by it's access token Request format[GET]:
-     * ../access_token/?access_token=<access_token>
+     * ../access_token/?access_token={access_token}
      *
      * @param accessToken access token
      * @return (OK) response status         (UNAUTHORIZED) wrong credentials
index fe600a9..6b7b670 100644 (file)
@@ -8,7 +8,7 @@ import java.util.Map;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public final class KafkaErrorMessages {
index 3ad7ba8..67886fe 100644 (file)
@@ -7,7 +7,7 @@ import java.util.Map;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public interface Publisher {
index c4ade56..203b490 100644 (file)
@@ -5,7 +5,7 @@ package com.samsung.servermq.iotivity.extractor;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public interface PostDataExtractor {
index adb9a80..b79f99a 100644 (file)
@@ -17,7 +17,7 @@ import com.samsung.servermq.utils.MessageQueueUtils;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href="https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public class DeviceRegistrationPostDataExtractor implements PostDataExtractor {
index c064fd4..1596be9 100644 (file)
@@ -14,7 +14,7 @@ import com.samsung.servermq.utils.MessageQueueUtils;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public class DeviceUnRegistrationPostDataExtractor implements PostDataExtractor {
index b80cbbe..708c595 100644 (file)
@@ -15,7 +15,7 @@ import com.samsung.servermq.utils.rest.ServerSender;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public class PolicyPostDataExtractor implements PostDataExtractor {
index c74b0a7..4782f4e 100644 (file)
@@ -19,7 +19,7 @@ import com.samsung.servermq.iotivity.report.PrepareReport;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public class ReportPostDataExtractor implements PostDataExtractor {
index ab5d687..3efa4b6 100644 (file)
@@ -5,7 +5,7 @@ package com.samsung.servermq.iotivity.report;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public class PrepareReport {
index 66b6ecb..8621410 100644 (file)
@@ -31,7 +31,7 @@ import com.samsung.servermq.iotivity.Publisher;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 @RestController
index 7494d03..5dc082d 100644 (file)
@@ -33,7 +33,7 @@ import com.fasterxml.jackson.dataformat.cbor.CBORFactory;
  * @param <T> the type parameter
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public class Cbor<T> {
index 39ff7bb..f1fafae 100644 (file)
@@ -31,7 +31,7 @@ import org.apache.log4j.Logger;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public final class MessageQueueUtils {
@@ -48,7 +48,6 @@ public final class MessageQueueUtils {
      * @param payload payload received
      * @param key     property key to get data
      * @return extracted data in payload
-     * @throws Exception
      */
     public static <T> T extractDataFromPayload(byte[] payload, String key) {
 
@@ -77,7 +76,6 @@ public final class MessageQueueUtils {
      * @param key   property key
      * @param value property value
      * @return cbor encoded payload with providing key and value
-     * @throws Exception
      */
     public static <T> byte[] buildPayload(String key, T value) {
 
index e18f741..4bdb294 100644 (file)
@@ -5,7 +5,7 @@ package com.samsung.servermq.utils.rest;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public interface ServerSender {
index 7d59898..0543625 100644 (file)
@@ -16,7 +16,7 @@ import org.springframework.web.client.RestTemplate;
  *
  * @author <A HREF="mailto:y.zozulia@samsung.com">Yevhen Zozulia</A>
  * @version 1.0
- * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol">
+ * @see <a href=      "https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol"></a>
  * @since 2017 -07-06
  */
 public class ServerSenderImpl implements ServerSender {
index 8f63f0d..9dad773 100644 (file)
                         </webApp>
                     </configuration>
                 </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-javadoc-plugin</artifactId>
+                    <version>3.0.0-M1</version>
+                </plugin>
             </plugins>
         </pluginManagement>
     </build>
 
+    <reporting>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.0.0-M1</version>
+            </plugin>
+        </plugins>
+    </reporting>
+
     <distributionManagement>
         <repository>
             <uniqueVersion>true</uniqueVersion>