diff --git a/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/committer/manifest/ManifestCommitterConstants.java b/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/committer/manifest/ManifestCommitterConstants.java index 8f359e45000f3..716e7b6e2f347 100644 --- a/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/committer/manifest/ManifestCommitterConstants.java +++ b/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/committer/manifest/ManifestCommitterConstants.java @@ -221,7 +221,7 @@ public final class ManifestCommitterConstants { public static final boolean OPT_DELETE_TARGET_FILES_DEFAULT = false; /** - * Name of the factory: {@value}. + * Name of the factory. */ public static final String MANIFEST_COMMITTER_FACTORY = ManifestCommitterFactory.class.getName(); @@ -235,7 +235,6 @@ public final class ManifestCommitterConstants { /** * Default classname of the store operations. - * Value: {@value}. */ public static final String STORE_OPERATIONS_CLASS_DEFAULT = ManifestStoreOperationsThroughFileSystem.class.getName(); diff --git a/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/committer/manifest/impl/ManifestStoreOperations.java b/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/committer/manifest/impl/ManifestStoreOperations.java index 03e3ce0f0ade0..a7a72cda296e5 100644 --- a/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/committer/manifest/impl/ManifestStoreOperations.java +++ b/hadoop-mapreduce-project/hadoop-mapreduce-client/hadoop-mapreduce-client-core/src/main/java/org/apache/hadoop/mapreduce/lib/output/committer/manifest/impl/ManifestStoreOperations.java @@ -69,7 +69,7 @@ public void bindToFileSystem(FileSystem fileSystem, Path path) throws IOExceptio /** * Is a path a file? Used during directory creation. - * The is a copy & paste of FileSystem.isFile(); + * The is a copy and paste of FileSystem.isFile(); * {@code StoreOperationsThroughFileSystem} calls into * the FS direct so that stores which optimize their probes * can save on IO. diff --git a/hadoop-project/src/site/site.xml b/hadoop-project/src/site/site.xml index 6cc69a082679a..33d4060cb1dc6 100644 --- a/hadoop-project/src/site/site.xml +++ b/hadoop-project/src/site/site.xml @@ -205,7 +205,7 @@
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppDetailsController.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppDetailsController.java index 63aefa615ffd4..686f07fa4714d 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppDetailsController.java +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppDetailsController.java @@ -52,6 +52,7 @@ public AppDetailsController() { /** * List detail information about the deployed application. * + *{@code
* @apiGroup AppDetailController
* @apiName getDetails
* @api {get} /app_details/config/{id} Check config of application instance.
@@ -113,8 +114,10 @@ public AppDetailsController() {
* }
* }
* }
- * @param id - Application ID
- * @return application entry-
+ * }
+ *
+ * @param id Application ID
+ * @return application entry
*/
@Path("config/{id}")
@GET
@@ -127,10 +130,12 @@ public AppEntry getDetails(@PathParam("id") String id) {
/**
* Check application status.
*
+ * {@code
* @apiGroup AppDetailController
* @apiName getStatus
* @api {get} /app_details/status/{id} Check status of application instance.
* @apiParam {String} id Application ID to check.
+ * @apiSuccess {Object} text Give status
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK
* {
@@ -195,8 +200,9 @@ public AppEntry getDetails(@PathParam("id") String id) {
* }
* }
* }
- * @apiSuccess {Object} text Give status
- * @param id - Application ID
+ * }
+ *
+ * @param id Application ID
* @return application entry
*/
@Path("status/{id}")
@@ -213,13 +219,16 @@ public AppEntry getStatus(@PathParam("id") String id) {
/**
* Stop an application.
*
+ * {@code
* @apiGroup AppDetailController
* @apiName stopApp
* @api {post} /app_details/stop/{id} Stop one instance of application.
* @apiParam {String} id Application ID to stop.
* @apiSuccess {String} text Give deployment status
* @apiError BadRequest Requested application does not stop.
- * @param id - Application ID
+ * }
+ *
+ * @param id Application ID
* @return Web response code
*/
@Path("stop/{id}")
@@ -242,13 +251,16 @@ public Response stopApp(@PathParam("id") String id) {
/**
* Restart an application.
*
+ * {@code
* @apiGroup AppDetailController
* @apiName restartApp
* @api {post} /app_details/restart/{id} Restart one instance of application.
* @apiParam {String} id Application ID to restart.
* @apiSuccess {String} text Give deployment status
* @apiError BadRequest Requested application does not restart.
- * @param id - Application ID
+ * }
+ *
+ * @param id Application ID
* @return Web response code
*/
@Path("restart/{id}")
@@ -271,12 +283,15 @@ public Response restartApp(@PathParam("id") String id) {
/**
* Upgrade an application.
*
+ * {@code
* @apiGroup AppDetailController
* @apiName upgradeApp
* @api {put} /app_details/upgrade/{id} Upgrade one instance of application.
* @apiParam {String} id Application Name to upgrade.
* @apiSuccess {String} text
* @apiError BadRequest Requested application does not upgrade.
+ * }
+ *
* @return Web response code
*/
@Path("upgrade/{id}")
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppListController.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppListController.java
index d818f23cdcf61..473d305cb15e8 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppListController.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppListController.java
@@ -51,6 +51,7 @@ public AppListController() {
/**
* Get Application List.
*
+ * {@code
* @apiGroup AppListController
* @apiName get
* @api {get} /app_list Get list of deployed applications.
@@ -116,7 +117,9 @@ public AppListController() {
* ...
* }
* ]
- * @return - Active application deployed by current user.
+ * }
+ *
+ * @return Active application deployed by current user.
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@@ -128,13 +131,16 @@ public List{@code
* @apiGroup AppListController
* @apiName delete
* @api {delete} /app_list Delete one instance of application.
* @apiParam {String} id Application name to delete.
* @apiSuccess {String} text Delete request accepted
- * @param id - application ID
- * @param name - application name
+ * }
+ *
+ * @param id application ID
+ * @param name application name
* @return Web response
*/
@DELETE
@@ -152,13 +158,16 @@ public Response delete(@PathParam("id") String id,
/**
* Deploy an application.
*
+ * {@code
* @apiGroup AppListController
* @apiName deploy
* @api {post} /app_list/{id} Deploy one instance of application.
* @apiParam {String} id Application ID to deploy.
* @apiSuccess {String} text Give deployment status
* @apiError BadRequest Unable to deploy requested application.
- * @param id - application ID
+ * }
+ *
+ * @param id application ID
* @return Web response
*/
@POST
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppStoreController.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppStoreController.java
index 5abb548b5dc10..1dff3b2f54a99 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppStoreController.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-applications-catalog/hadoop-yarn-applications-catalog-webapp/src/main/java/org/apache/hadoop/yarn/appcatalog/controller/AppStoreController.java
@@ -49,6 +49,7 @@ public AppStoreController() {
/**
* Display the most frequently used applications on YARN AppCatalog home page.
*
+ * {@code
* @apiGroup AppStoreController
* @apiName get
* @api {get} /app_store/recommended Display recommended applications.
@@ -70,7 +71,9 @@ public AppStoreController() {
* ...
* }
* ]
- * @return - List of YARN applications
+ * }
+ *
+ * @return List of YARN applications
*/
@GET
@Path("recommended")
@@ -83,6 +86,7 @@ public List{@code
* @apiGroup AppStoreController
* @apiName search
* @api {get} /app_store/search Find application from appstore.
@@ -105,8 +109,10 @@ public List get() {
* ...
* }
* ]
- * @param keyword - search for keyword
- * @return - List of YARN applications matching keyword search.
+ * }
+ *
+ * @param keyword search for keyword
+ * @return List of YARN applications matching keyword search.
*/
@GET
@Path("search")
@@ -133,6 +139,7 @@ public AppStoreEntry get(@PathParam("id") String id) {
/**
* Register an application.
*
+ * {@code
* @apiGroup AppStoreController
* @apiName register
* @api {post} /app_store/register Register an application in appstore.
@@ -171,7 +178,9 @@ public AppStoreEntry get(@PathParam("id") String id) {
* }
* @apiSuccess {String} Response Application register result.
* @apiError BadRequest Error in process application registration.
- * @param app - Yarnfile in JSON form
+ * }
+ *
+ * @param app Yarnfile in JSON form
* @return Web response
*/
@POST
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services/hadoop-yarn-services-core/src/main/java/org/apache/hadoop/yarn/service/api/records/Component.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services/hadoop-yarn-services-core/src/main/java/org/apache/hadoop/yarn/service/api/records/Component.java
index 8a5b7d402f773..1d66875d0a904 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services/hadoop-yarn-services-core/src/main/java/org/apache/hadoop/yarn/service/api/records/Component.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-applications/hadoop-yarn-services/hadoop-yarn-services-core/src/main/java/org/apache/hadoop/yarn/service/api/records/Component.java
@@ -116,8 +116,6 @@ public class Component implements Serializable {
* ON_FAILURE (Only restart component instance if instance exit code !=
* 0);
* NEVER (Do not restart in any cases)
- *
- * @return restartPolicy
**/
@XmlType(name = "restart_policy")
@XmlEnum
diff --git a/pom.xml b/pom.xml
index 69fc7ed5ec497..a29c22e5f7bbe 100644
--- a/pom.xml
+++ b/pom.xml
@@ -100,14 +100,14 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/x