updated readme and java docs

Author: jeetchoudhary

README.md

@@ -309,7 +309,7 @@ Before you run the integration tests (locally):
 1. Run integration tests by running
 
    ```
-   make itest-local-changes
+   make integration-test
    ```
 
 ### Release Process

dockerfile-image-update/src/main/java/com/salesforce/dockerfileimageupdate/utils/RateLimit.java

@@ -44,17 +44,17 @@ public RateLimit() {
     }
 
     /**
-     * This method will accept an input string in format <integer>-<ISO-8601_formatted_time> and
+     * This method will accept an input string in format &lt;integer&gt;-&lt;ISO-8601_formatted_time&gt;  and
      * will tokenize it to create a RateLimit object.
      * <pre>
      * Examples of tokenization
-     * input : 500-PT1S -> {rate : 500, duration 1 second (PT1S), token adding rate: every .002 seconds (PT0.002S)}
-     *         60-PT1M -> {rate : 60, duration 1 minute (PT1M), token adding rate: every 1 seconds (PT1S)}
+     * input : 500-PT1S means {rate : 500, duration 1 second (PT1S), token adding rate: every .002 seconds (PT0.002S)}
+     *         60-PT1M means {rate : 60, duration 1 minute (PT1M), token adding rate: every 1 seconds (PT1S)}
      * </pre>
      *
-     * @param input string in format <integer>-<ISO-8601 formatted_time]> example 500-PT1S , 500-PT60S , 500-PT1H
+     * @param input string in format &lt;integer&gt;-&lt;ISO-8601_formatted_time&gt;  example 500-PT1S , 500-PT60S , 500-PT1H
      * @return RateLimit based on the input value
-     * @throws UnknownFormatConversionException if input is not a string with expected format <integer>-<ISO-8601_formatted_time>
+     * @throws UnknownFormatConversionException if input is not a string with expected format &lt;integer&gt;-&lt;ISO-8601_formatted_time&gt;
      */
     public static RateLimit tokenizeAndGetRateLimit(String input) throws UnknownFormatConversionException {
         if (StringUtils.isEmpty(input) || !input.contains("-")) {

dockerfile-image-update/src/main/java/com/salesforce/dockerfileimageupdate/utils/RateLimiter.java

@@ -21,8 +21,7 @@
  * time, the number of tokens in the bucket won't exceed the 'rateLimit', limiting the rate at
  * which PRs would be raised. To keep the refill rate uniform, one token will be added to the
  * bucket every 'tokenAddingRate'. If no tokens are left in the bucket, then PR won't be raised
- * and program will halt until next token is available.
- * <pre>
+ * and program will halt until next token is available.</pre>
  */
 public class RateLimiter {
 
@@ -32,11 +31,11 @@ public class RateLimiter {
     /**
      * constructor to initialize RateLimiter with required values.
      * If time meter is not specified, the system default will be chosen.
-     *
-     * @param customTimeMeter Clock to be used for bucketing the tokens.
-     *                        Defaults to TimeMeter.SYSTEM_MILLISECONDS
-     * @param <T>             Implementing class for customTimeMeter must be a class
-     *                        extending TimeMeter
+     * @param rateLimit RateLimit object
+     * @param customTimeMeter custom time metere. should be of type TimeMeter
+     * @param <T> Implementing class for customTimeMeter must be a class
+     *           extending TimeMeter
+     * @see RateLimit
      * @see TimeMeter
      * @see TimeMeter#SYSTEM_MILLISECONDS
      */
@@ -70,7 +69,7 @@ public RateLimiter() {
      * This method will create and return an object of type RateLimiter based on the
      * variable set in the Namespace.
      *
-     * @param ns Namespace {@see net.sourceforge.argparse4j.inf.Namespace}
+     * @param ns Namespace
      * @return RateLimiter object if required variable is set in Namespace
      * null otherwise.
      * @see net.sourceforge.argparse4j.inf.Namespace Namespace