fix some Javadoc warnings (#2627)

Author: Vladimir Kotal

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/Ctags.java

@@ -392,7 +392,7 @@ public Definitions doCtags(String file) throws IOException,
      *
      * @param bufferTags tags file output
      * @return definitions parsed from buffer
-     * @throws java.lang.InterruptedException
+     * @throws java.lang.InterruptedException interrupted
      */
     public Definitions testCtagsParser(String bufferTags)
             throws InterruptedException {

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/JFlexXrefUtils.java

@@ -183,7 +183,7 @@ public static String generateId(Scope scope) {
      * {@link Definitions#getTags(int)} indicates that a function or method
      * is defined to starting at the {@link JFlexStackingLexer#getLineNumber()}
      * of {@code lexer}.
-     * @param scopesEnabled
+     * @param scopesEnabled are scopes enabled ?
      * @param existingScope possibly a defined instance or null
      * @param lexer a defined, associated lexer
      * @param defs possibly a defined instance or null

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/OGKTextField.java

@@ -44,27 +44,37 @@ public class OGKTextField extends Field {
 
     /**
      * Creates a new un-stored instance with {@link Reader} value.
+     * @param name field name
+     * @param reader reader
      */
     public OGKTextField(String name, Reader reader) {
         super(name, reader, TYPE_NOT_STORED);
     }
 
     /**
      * Creates a new instance with {@link Reader} value.
+     * @param name field name
+     * @param reader reader
+     * @param store store
      */
     public OGKTextField(String name, Reader reader, Store store) {
         super(name, reader, store == Store.YES ? TYPE_STORED : TYPE_NOT_STORED);
     }
 
     /**
      * Creates a new instance with {@code String} value.
+     * @param name field name
+     * @param value string value
+     * @param store store
      */
     public OGKTextField(String name, String value, Store store) {
         super(name, value, store == Store.YES ? TYPE_STORED : TYPE_NOT_STORED);
     }
 
     /**
      * Creates a new un-stored instance with {@link TokenStream} value.
+     * @param name field name
+     * @param stream stream
      */
     public OGKTextField(String name, TokenStream stream) {
         super(name, stream, TYPE_NOT_STORED);

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/OGKTextVecField.java

@@ -46,27 +46,37 @@ public class OGKTextVecField extends Field {
 
     /**
      * Creates a new un-stored instance with {@link Reader} value.
+     * @param name field name
+     * @param reader reader
      */
     public OGKTextVecField(String name, Reader reader) {
         super(name, reader, TYPE_NOT_STORED);
     }
 
     /**
      * Creates a new instance with {@link Reader} value.
+     * @param name field name
+     * @param reader reader
+     * @param store store
      */
     public OGKTextVecField(String name, Reader reader, Store store) {
         super(name, reader, store == Store.YES ? TYPE_STORED : TYPE_NOT_STORED);
     }
 
     /**
      * Creates a new instance with {@code String} value.
+     * @param name field name
+     * @param value string value
+     * @param store store
      */
     public OGKTextVecField(String name, String value, Store store) {
         super(name, value, store == Store.YES ? TYPE_STORED : TYPE_NOT_STORED);
     }
 
     /**
      * Creates a new un-stored instance with {@link TokenStream} value.
+     * @param name field name
+     * @param stream stream
      */
     public OGKTextVecField(String name, TokenStream stream) {
         super(name, stream, TYPE_NOT_STORED);

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/PendingToken.java

@@ -44,9 +44,9 @@ public class PendingToken {
     /**
      * Initializes an instance with immutable fields for the specified
      * arguments.
-     * @param str
-     * @param start
-     * @param end
+     * @param str string value
+     * @param start start offset
+     * @param end end offset
      */
     public PendingToken(String str, int start, int end) {
         this.str = str;
@@ -56,7 +56,7 @@ public PendingToken(String str, int start, int end) {
 
     /**
      * Compares this instance's immutable fields to the other.
-     * @param o
+     * @param o object
      * @return {@code true} if the objects are equal
      */
     @Override

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/perl/PerlLexHelper.java

@@ -44,6 +44,7 @@ interface PerlLexer extends JFlexJointLexer {
      * Indicates that a premature end of quoting occurred. Everything up to the
      * causal character has been written, and anything following will be
      * indicated via {@link yypushback}.
+     * @throws IOException I/O exception
      */
     void abortQuote() throws IOException;
 }

opengrok-indexer/src/main/java/org/opengrok/indexer/configuration/RuntimeEnvironment.java

@@ -236,7 +236,7 @@ public Object getConfigurationValue(String fieldName) {
      * Get value of configuration field
      * @param fieldName name of the field
      * @return object value
-     * @throws IOException
+     * @throws IOException I/O
      */
     public Object getConfigurationValueException(String fieldName) throws IOException {
         try {
@@ -285,6 +285,7 @@ public void setConfigurationValue(String fieldName, Object value) {
      * Set configuration value
      * @param fieldName name of the field
      * @param value value
+     * @throws IOException I/O exception
      */
     public void setConfigurationValueException(String fieldName, Object value) throws IOException {
         try {
@@ -299,6 +300,7 @@ public void setConfigurationValueException(String fieldName, Object value) throw
      * Set configuration value
      * @param fieldName name of the field
      * @param value string value
+     * @throws IOException I/O exception
      */
     public void setConfigurationValueException(String fieldName, String value) throws IOException {
         try {
@@ -1009,7 +1011,7 @@ public String getBugPattern() {
      * Sets the bug regex for the history listing
      *
      * @param bugPattern the regex to search history comments
-     * @throws IOException
+     * @throws IOException I/O
      */
     public void setBugPattern(String bugPattern) throws IOException {
         setConfigurationValueException("bugPattern", bugPattern);
@@ -1046,7 +1048,7 @@ public String getReviewPattern() {
      * Sets the review(ARC) regex for the history listing
      *
      * @param reviewPattern the regex to search history comments
-     * @throws IOException
+     * @throws IOException I/O
      */
     public void setReviewPattern(String reviewPattern) throws IOException {
         setConfigurationValueException("reviewPattern", reviewPattern);
@@ -1339,7 +1341,7 @@ public void readConfiguration(File file) throws IOException {
      * Read configuration from a file and put it into effect.
      * @param file the file to read
      * @param interactive true if run in interactive mode
-     * @throws IOException
+     * @throws IOException I/O
      */
     public void readConfiguration(File file, boolean interactive) throws IOException {
         setConfiguration(Configuration.read(file), null, interactive);

opengrok-indexer/src/main/java/org/opengrok/indexer/history/HistoryGuru.java

@@ -309,7 +309,7 @@ public boolean hasHistory(File file) {
 
     /**
      * Does the history cache contain entry for this directory ?
-     * @param file
+     * @param file file object
      * @return true if there is cache, false otherwise
      */
     public boolean hasCacheForFile(File file) {
@@ -878,6 +878,7 @@ public void removeRepositories(Collection<String> repos) {
      * Set list of known repositories which match the list of directories.
      * @param repos list of repositories
      * @param dirs list of directories that might correspond to the repositories
+     * @param interactive interactive mode flag
      */
     public void invalidateRepositories(Collection<? extends RepositoryInfo> repos, List<String> dirs, boolean interactive) {
         if (repos != null && !repos.isEmpty() && dirs != null && !dirs.isEmpty()) {
@@ -910,6 +911,7 @@ public void invalidateRepositories(Collection<? extends RepositoryInfo> repos, L
      *
      * @param repos collection of repositories to invalidate.
      * If null or empty, the internal map of repositories will be cleared.
+     * @param interactive interactive mode flag
      */
     public void invalidateRepositories(Collection<? extends RepositoryInfo> repos, boolean interactive) {
         if (repos == null || repos.isEmpty()) {

opengrok-indexer/src/main/java/org/opengrok/indexer/history/PerforceRepository.java

@@ -121,6 +121,7 @@ public boolean fileHasAnnotation(File file) {
      * Check if a given file is in the depot
      *
      * @param file The file to test
+     * @param interactive interactive mode flag
      * @return true if the given file is in the depot, false otherwise
      */
     public static boolean isInP4Depot(File file, boolean interactive) {

opengrok-indexer/src/main/java/org/opengrok/indexer/history/Repository.java

@@ -385,6 +385,7 @@ final void createCache(HistoryCache cache, String sinceRevision)
      * Check if this it the right repository type for the given file.
      *
      * @param file File to check if this is a repository for.
+     * @param interactive is this run from interactive mode
      * @return true if this is the correct repository for this file/directory.
      */
     abstract boolean isRepositoryFor(File file, boolean interactive);
@@ -401,7 +402,7 @@ public final boolean isRepositoryFor(File file) {
     /**
      * Determine parent of this repository.
      * @return parent
-     * @throws java.io.IOException
+     * @throws java.io.IOException I/O exception
      */
     public final String determineParent() throws IOException {
         return determineParent(false);
@@ -415,7 +416,7 @@ public final String determineParent() throws IOException {
     /**
      * Determine branch of this repository.
      * @return branch
-     * @throws java.io.IOException
+     * @throws java.io.IOException I/O exception
      */
     public final String determineBranch() throws IOException {
         return determineBranch(false);