fix some Javadoc warnings

Author: vladak

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

@@ -125,6 +125,8 @@ public abstract void analyze(Document doc, StreamSource src, Writer xrefOut)
     /**
      * Subclasses must override to incorporate a determined number of lines and
      * lines-of-code (LOC).
+     * @param doc Document instance
+     * @param counts NumLinesLOC instance
      */
     protected abstract void addNumLinesLOC(Document doc, NumLinesLOC counts);
 

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

@@ -509,6 +509,7 @@ public static void addExtension(String extension, AnalyzerFactory factory) {
      * {@link #addExtension(String, AnalyzerFactory)} and
      * {@link #addPrefix(String, AnalyzerFactory)} merged with default language
      * mappings of OpenGrok's analyzers.
+     * @return LangMap instance
      */
     public static LangMap getLangMap() {
         return langMap.mergeSecondary(defaultLangMap).unmodifiable();

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

@@ -94,6 +94,8 @@ public Xrefer writeXref(WriteXrefArgs args) throws IOException {
     /**
      * Gets a BOM-stripped {@link Reader} (default UTF-8 charset) of the
      * specified {@code stream}, wrapped in a {@link ZeroReader}.
+     * @param stream input stream
+     * @return Reader instance
      */
     protected Reader getReader(InputStream stream) throws IOException {
         // sourceRoot is read with UTF-8 as a default.

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

@@ -1066,13 +1066,15 @@ public void setWebappLAF(String webappLAF) {
 
     /**
      * Gets a value indicating if the web app should run ctags as necessary.
+     * @return true if ctags should be run, false otherwise
      */
     public boolean isWebappCtags() {
         return webappCtags;
     }
 
     /**
      * Sets a value indicating if the web app should run ctags as necessary.
+     * @param value true or false
      */
     public void setWebappCtags(boolean value) {
         this.webappCtags = value;

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

@@ -187,7 +187,10 @@ public WatchDogService getWatchDog() {
         return watchDog;
     }
 
-    /** Gets the thread pool used for multi-project searches. */
+    /**
+     * Gets the thread pool used for multi-project searches.
+     * @return ExecutorService instance
+     */
     public ExecutorService getSearchExecutor() {
         return lzSearchExecutor.get();
     }
@@ -252,6 +255,7 @@ public IndexerParallelizer getIndexerParallelizer() {
 
     /**
      * Gets an instance associated to this environment.
+     * @return PathAccepter instance
      */
     public PathAccepter getPathAccepter() {
         return new PathAccepter(getIgnoredNames(), getIncludedNames());
@@ -1510,6 +1514,8 @@ public String getConfigurationXML() {
      *
      * @param host the host address to receive the configuration
      * @throws IOException if an error occurs
+     * @throws InterruptedException on timeout
+     * @throws IllegalArgumentException on invalid configuration
      */
     public void writeConfiguration(String host) throws IOException, InterruptedException, IllegalArgumentException {
         String configXML = syncReadConfiguration(Configuration::getXMLRepresentationAsString);

opengrok-indexer/src/main/java/org/opengrok/indexer/search/context/OGKUnifiedHighlighter.java

@@ -50,13 +50,11 @@
 import org.opengrok.indexer.web.Util;
 
 /**
- * Represents a subclass of {@link UnifiedHighlighter} with customizations for
- * OpenGrok.
+ * Represents a subclass of {@link UnifiedHighlighter} with customizations for OpenGrok.
  */
 public class OGKUnifiedHighlighter extends UnifiedHighlighter {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(
-        OGKUnifiedHighlighter.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(OGKUnifiedHighlighter.class);
 
     private final RuntimeEnvironment env;
 
@@ -74,8 +72,7 @@ public class OGKUnifiedHighlighter extends UnifiedHighlighter {
      * @param indexAnalyzer a required instance
      * @throws IllegalArgumentException if any argument is null
      */
-    public OGKUnifiedHighlighter(RuntimeEnvironment env,
-            IndexSearcher indexSearcher, Analyzer indexAnalyzer) {
+    public OGKUnifiedHighlighter(RuntimeEnvironment env, IndexSearcher indexSearcher, Analyzer indexAnalyzer) {
         super(indexSearcher, indexAnalyzer);
 
         if (env == null) {

opengrok-indexer/src/main/java/org/opengrok/indexer/web/Util.java

@@ -849,6 +849,8 @@ public static String uid2url(String uid) {
      * {@link org.opengrok.indexer.index.Indexer#PATH_SEPARATOR} in order not
      * to conflict with the Lucene escape character and also so {@code path}
      * appears as a correctly formed URI in search results.
+     * @param path path to fix
+     * @return fixed path
      */
     public static String fixPathIfWindows(String path) {
         if (path != null && SystemUtils.IS_OS_WINDOWS) {