[ambari] branch trunk updated: AMBARI-24835. Fix javadoc errors in ambari-utility (#2523)

[ad...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

adoroszlai pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ambari.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 5311ecb  AMBARI-24835. Fix javadoc errors in ambari-utility (#2523)
5311ecb is described below

commit 5311ecbfef9de3828c4a9b20700a6819f98297bc
Author: Doroszlai, Attila <64...@users.noreply.github.com>
AuthorDate: Fri Oct 26 21:38:58 2018 +0200

    AMBARI-24835. Fix javadoc errors in ambari-utility (#2523)
---
 .../ambari/annotations/SwaggerOverwriteNestedAPI.java    | 16 ++++++----------
 .../ambari/annotations/SwaggerPreferredParent.java       |  5 ++---
 2 files changed, 8 insertions(+), 13 deletions(-)

diff --git a/ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java b/ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java
index 29e4024..7cfb94a 100644
--- a/ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java
+++ b/ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerOverwriteNestedAPI.java
@@ -25,7 +25,7 @@ import java.lang.annotation.Target;
 
 /**
  * The {@link SwaggerOverwriteNestedAPI} is used to overwrite default values of
- * {@link org.apache.ambari.swagger.NestedApiRecord} when {@link org.apache.ambari.swagger.AmbariSwaggerReader}
+ * {@code NestedApiRecord} when {@link org.apache.ambari.swagger.AmbariSwaggerReader}
  * processes nested API classes for Swagger annotations.
  *
  * It can be useful to overcome the limitations of multi-nested service endpoints or endpoints without Path
@@ -38,26 +38,22 @@ import java.lang.annotation.Target;
 public @interface SwaggerOverwriteNestedAPI {
 
     /**
-     * Class name of parent object
-     * @return
+     * @return class name of parent object
      */
-    Class parentApi();
+    Class<?> parentApi();
 
     /**
-     * Parent API path, usually top-level API path starting with slash.
-     * @return
+     * @return parent API path, usually top-level API path starting with slash.
      */
     String parentApiPath();
 
     /**
-     * Path annotation value of the method in parent class.
-     * @return
+     * @return path annotation value of the method in parent class.
      */
     String parentMethodPath();
 
     /**
-     * Array of Strings to provide path parameters. Only string types are supported as of now.
-     * @return
+     * @return array of Strings to provide path parameters. Only string types are supported as of now.
      */
     String[] pathParameters();
 }
diff --git a/ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerPreferredParent.java b/ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerPreferredParent.java
index fcd7590..222f9db 100644
--- a/ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerPreferredParent.java
+++ b/ambari-utility/src/main/java/org/apache/ambari/annotations/SwaggerPreferredParent.java
@@ -33,8 +33,7 @@ import java.lang.annotation.Target;
 public @interface SwaggerPreferredParent {
 
     /**
-     * Class name of preferred parent object
-     * @return
+     * @return class name of preferred parent object
      */
-    Class preferredParent();
+    Class<?> preferredParent();
 }