[Codeathon]Fix errors on javadoc generation on core-util see

issue #2795

core/util/src/main/java/org/phoebus/util/FileExtensionUtil.java

@@ -20,6 +20,9 @@
 
 import java.io.File;
 
+/**
+ * Class FileExtensionUtil
+ */
 public class FileExtensionUtil {
 
     /**

core/util/src/main/java/org/phoebus/util/indexname/IndexNameHelper.java

@@ -16,7 +16,6 @@
  * Helper class for calculating the index name for time based indices.
  * @author Evan Smith
  */
-@SuppressWarnings("nls")
 public class IndexNameHelper
 {
     private String baseIndexName;
@@ -66,9 +65,9 @@ public IndexNameHelper(final String baseIndexName, final boolean useDatedIndexNa
     }
 
     /**
-     * Return a time based index name for the given time. If the dateSpanValue is 0 then returns the base index name.
-     * @param time
-     * @return index_name
+     * Return a time based index name for the given time
+     * @param time given time
+     * @return index_name If the dateSpanValue is 0 then returns the base index name
      */
     public String getIndexName(Instant time)
     {
@@ -136,11 +135,13 @@ private String parseCurrentDateSpan()
         return fullDate.split(DELIMITER)[0];
     }
 
+    /** @return current date span start   */
     public Instant getCurrentDateSpanStart()
     {
         return spanStart;
     }
 
+    /** @return current date span end   */
     public Instant getCurrentDateSpanEnd()
     {
         return spanEnd;

core/util/src/main/java/org/phoebus/util/shell/CommandShell.java

@@ -20,10 +20,11 @@
  *
  *  @author Kay Kasemir
  */
-@SuppressWarnings("nls")
 public class CommandShell
 {
-    public interface CommandHandler
+    /**
+     * interface CommandHandler */
+	public interface CommandHandler
     {
         /** Invoked when user entered a command
          *  @param args Entered command, split at spaces, or <code>null</code> when user entered 'Ctrl-D' to close shell
@@ -64,13 +65,16 @@ public void stop()
         thread.interrupt();
     }
 
-    /** Get the prompt string. */
+    /** @return the prompt string. */
     public String getPrompt()
     {
         return prompt;
     }
 
-    /** Set the prompt string. */
+    /**
+     * Set the prompt string
+     * @param newPrompt the new prompt
+     */
     public void setPrompt(final String newPrompt)
     {
         this.prompt = newPrompt;

core/util/src/main/java/org/phoebus/util/text/CompareNatural.java

@@ -17,8 +17,15 @@
  */
 public class CompareNatural
 {
-    public static final Comparator<String> INSTANCE = (a, b) -> compareTo(a, b);
-
+    /** Singleton */
+	public static final Comparator<String> INSTANCE = (a, b) -> compareTo(a, b);
+
+	/**
+	 * Compare two string 
+	 * @param s1 string 1
+	 * @param s2 string 2
+	 * @return result of comparison
+	 */
     public static int compareTo(final String s1, final String s2)
     {
        // Skip all identical characters

core/util/src/main/java/org/phoebus/util/time/SecondsParser.java

@@ -34,10 +34,10 @@ public class SecondsParser
      *  Special cases:
      *  One overall '-' is allowed to specify negative seconds.
      *
+     *  @param text time in string
      *  @return The seconds parsed from the string.
      *  @throws Exception on parse error.
      */
-    @SuppressWarnings("nls")
     public static double parseSeconds(String text) throws Exception
     {
         final char sep = ':';

core/util/src/main/java/org/phoebus/util/time/TimeDuration.java

@@ -22,14 +22,20 @@ public class TimeDuration {
     private TimeDuration() {
     }
 
+    /**
+     * Create a Duration
+     * @param sec seconds
+     * @param nanoSec nanoseconds
+     * @return duration 
+     */
     public static Duration createDuration(long sec, int nanoSec) {
         return Duration.ofSeconds(sec).plusNanos(nanoSec);
     }
 
     /**
-     * A new duration in hours.
+     * A new duration in days.
      *
-     * @param hour hours
+     * @param day day
      * @return a new duration
      */
     public static Duration ofDays(double day) {
@@ -109,7 +115,7 @@ public static double toSecondsDouble(Duration duration){
     /**
      * The number of seconds concatenated with the number of nanoseconds (12.500000000
      * for 12.5 seconds).
-     *
+     * @param duration the duration
      * @return the string representation
      */
     public static String toSecondString(Duration duration){

core/util/src/main/java/org/phoebus/util/time/TimeParser.java

@@ -34,7 +34,6 @@
  *
  * @author shroffk
  */
-@SuppressWarnings("nls")
 public class TimeParser {
     /** Text for the relative {@link TemporalAmount} of size 0 */
     public static final String NOW = "now";
@@ -74,7 +73,7 @@ public static Instant getInstant(String time) {
 
     /**
      * Return a {@link TimeInterval} between this instant represented by the string and NOW
-     * @param time
+     * @param time in string
      * @return TimeInterval
      */
     @Deprecated
@@ -99,8 +98,8 @@ public static TimeInterval getTimeInterval(String time) {
      *
      * e.g. parseDuraiton("5h 3min 34s");
      *
-     * @param string
-     * @return
+     * @param string time in string
+     * @return duration
      * @deprecated use {@link #parseTemporalAmount(String)}
      */
     @Deprecated
@@ -368,7 +367,7 @@ else if (period.getDays() > 0)
     }
 
     /** Try to parse text as absolute or relative time
-     *  @param text
+     *  @param text temporal amount
      *  @return {@link Instant}, {@link TemporalAmount} or <code>null</code>
      */
     public static Object parseInstantOrTemporalAmount(final String text)

core/util/src/main/java/org/phoebus/util/time/TimeRelativeInterval.java

@@ -28,7 +28,6 @@
  *
  * @author carcassi, shroffk
  */
-@SuppressWarnings("nls")
 public class TimeRelativeInterval {
 
     private final Object start;
@@ -229,6 +228,10 @@ public Optional<TemporalAmount> getRelativeEnd() {
         }
     }
 
+    /**
+     * @param reference time
+     * @return absolute interval
+     */
     public TimeInterval toAbsoluteInterval(Instant reference) {
         Instant absoluteStart;
         Instant absoluteEnd;
@@ -288,6 +291,7 @@ public TimeInterval toAbsoluteInterval(Instant reference) {
         return TimeInterval.between(absoluteStart, absoluteEnd);
     }
 
+    /** @return time interval */
     public TimeInterval toAbsoluteInterval() {
         return toAbsoluteInterval(Instant.now());
     }

core/util/src/main/java/org/phoebus/util/time/package-info.java

@@ -4,7 +4,7 @@
  */
 /**
  * Contains basic common classes to handle time at nanosecond precision.
- * <h3>JSR 310 compatibility</h3>
+ * JSR 310 compatibility
  * Java 8 has introduced a better time definition that is going to be very
  * similar to these class. The plan is to phase out this package
  * and use the standard where possible.