From f8d61b9fc2259e7bfd503924a0c2e41a0955aaed Mon Sep 17 00:00:00 2001 From: Anu Engineer Date: Thu, 18 Oct 2018 12:14:54 -0700 Subject: [PATCH] HDDS-690. Javadoc build fails in hadoop-ozone. Contributed by Takanobu Asanuma. --- .../org/apache/hadoop/ozone/client/BucketArgs.java | 2 +- .../apache/hadoop/ozone/om/helpers/OmBucketArgs.java | 4 ++-- .../apache/hadoop/ozone/om/helpers/OmBucketInfo.java | 2 +- .../apache/hadoop/ozone/om/helpers/OmKeyInfo.java | 1 - .../hadoop/ozone/web/handlers/VolumeHandler.java | 6 ++++-- .../hadoop/ozone/web/interfaces/Accounting.java | 2 +- .../apache/hadoop/ozone/web/interfaces/Volume.java | 12 +++++++----- .../java/org/apache/hadoop/ozone/om/KeyManager.java | 2 +- .../org/apache/hadoop/ozone/om/OzoneManagerLock.java | 7 ++++--- .../hadoop/ozone/om/ServiceListJSONServlet.java | 4 ++-- .../genconf/GenerateOzoneRequiredConfigurations.java | 2 +- 11 files changed, 24 insertions(+), 20 deletions(-) diff --git a/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java b/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java index d86062bc76..e68e9f1b64 100644 --- a/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java +++ b/hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java @@ -74,7 +74,7 @@ public StorageType getStorageType() { /** * Returns the ACL's associated with this bucket. - * @return List + * @return {@literal List} */ public List getAcls() { return acls; diff --git a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java index 381913112f..a3ae7e5f10 100644 --- a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java +++ b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketArgs.java @@ -100,7 +100,7 @@ public String getBucketName() { /** * Returns the ACL's that are to be added. - * @return List + * @return {@literal List} */ public List getAddAcls() { return addAcls; @@ -108,7 +108,7 @@ public List getAddAcls() { /** * Returns the ACL's that are to be removed. - * @return List + * @return {@literal List} */ public List getRemoveAcls() { return removeAcls; diff --git a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java index 4418738151..0bff1f7026 100644 --- a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java +++ b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmBucketInfo.java @@ -101,7 +101,7 @@ public String getBucketName() { /** * Returns the ACL's associated with this bucket. - * @return List + * @return {@literal List} */ public List getAcls() { return acls; diff --git a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java index 50f4b17508..c9a7e483a5 100644 --- a/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java +++ b/hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/OmKeyInfo.java @@ -119,7 +119,6 @@ public void updateModifcationTime() { * This will be called when the key is being committed to OzoneManager. * * @param locationInfoList list of locationInfo - * @throws IOException */ public void updateLocationInfoList(List locationInfoList) { long latestVersion = getLatestVersionLocations().getVersion(); diff --git a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java index 002f289090..bd04ea6ea0 100644 --- a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java +++ b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/handlers/VolumeHandler.java @@ -60,7 +60,8 @@ public class VolumeHandler implements Volume { * Creates a volume. * * @param volume Volume Name, this has to be unique at Ozone cluster level - * @param quota Quota for this Storage Volume - () + * @param quota Quota for this Storage Volume + * - {@literal ()} * @param req Request Object * @param uriInfo URI info * @param headers Http Headers @@ -114,7 +115,8 @@ public Response doProcess(VolumeArgs args) * with neither of these actions, update just returns 200 OK. * * @param volume Volume Name, this has to be unique at Ozone Level - * @param quota Quota for this volume - ()|remove + * @param quota Quota for this volume + * - {@literal ()}|remove * @param req - Request Object * @param uriInfo - URI info * @param headers Http Headers diff --git a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java index f03276c487..73290b3aee 100644 --- a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java +++ b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Accounting.java @@ -25,7 +25,7 @@ * TODO : Technically we need to report bucket creation and deletion too * since the bucket names and metadata consume storage. *

- * TODO : We should separate out reporting metadata & data -- + * TODO : We should separate out reporting metadata & data -- *

* In some cases end users will only want to account for the data they are * storing since metadata is mostly a cost of business. diff --git a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java index 85b2240277..ce370421e3 100644 --- a/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java +++ b/hadoop-ozone/objectstore-service/src/main/java/org/apache/hadoop/ozone/web/interfaces/Volume.java @@ -54,11 +54,12 @@ public interface Volume { * * Params : * Quota - Specifies the Maximum usable size by the user - * the valid parameters for quota are () | remove. - * For example 10GB or "remove". + * the valid parameters for quota are {@literal ()} + * | remove. For example 10GB or "remove". * * @param volume Volume Name, this has to be unique at Ozone Level - * @param quota Quota for this Storage Volume - () | remove + * @param quota Quota for this Storage Volume - {@literal ()} + * | remove * @param req - Request Object - Request Object * @param uriInfo - Http UriInfo * @param headers Http Headers HttpHeaders @@ -91,11 +92,12 @@ Response createVolume(@PathParam("volume") String volume, * Params : * Owner - Specifies the name of the owner * Quota - Specifies the Maximum usable size by the user - * the valid parameters for quota are () | remove. + * the valid parameters for quota are {@literal ()} | remove. * For example 10GB or "remove". * * @param volume Volume Name, this has to be unique at Ozone Level - * @param quota Quota for this Storage Volume - () | remove + * @param quota Quota for this Storage Volume - {@literal ()} + * | remove * @param req - Request Object - Request Object * @param headers Http Headers HttpHeaders * diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java index 83363e72ad..b7b45172a1 100644 --- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java +++ b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/KeyManager.java @@ -72,7 +72,7 @@ OmKeyLocationInfo allocateBlock(OmKeyArgs args, long clientID) * * @param args the args of the key provided by client. * @return a OpenKeySession instance client uses to talk to container. - * @throws Exception + * @throws IOException */ OpenKeySession openKey(OmKeyArgs args) throws IOException; diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java index 6203ddfaee..c5ce9e25af 100644 --- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java +++ b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerLock.java @@ -33,6 +33,7 @@ * We also maintain lock hierarchy, based on the weight. * * + * * * * @@ -53,9 +54,9 @@ *

* For example: *
- * -> acquireVolumeLock (will work)
- * +-> acquireBucketLock (will work)
- * +--> acquireUserLock (will throw Exception)
+ * {@literal ->} acquireVolumeLock (will work)
+ * {@literal +->} acquireBucketLock (will work)
+ * {@literal +-->} acquireUserLock (will throw Exception)
*

*
* To acquire a user lock you should not hold any Volume/Bucket lock. Similarly diff --git a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java index 47713e2010..acc1634105 100644 --- a/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java +++ b/hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/ServiceListJSONServlet.java @@ -41,7 +41,7 @@ * * The return format is of JSON and in the form *

- * 

+ *  

  *  {
  *    "services" : [
  *      {
@@ -54,7 +54,7 @@
  *      }
  *    ]
  *  }
- *  

+ *
*

* */ diff --git a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java index b58cfc2678..5d27838b74 100644 --- a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java +++ b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/genconf/GenerateOzoneRequiredConfigurations.java @@ -40,7 +40,7 @@ * This tool generates an ozone-site.xml with minimally required configs. * This tool can be invoked as follows:
*

    - *
  • ozone genconf
    • + *
  • ozone genconf {@literal }
    • *
  • ozone genconf --help
    • *
  • ozone genconf -h
    • *
WEIGHT LOCK