fixing javadoc errors

oracle · Feb 3, 2019 · 2022f6d · 2022f6d
1 parent 706ed48
commit 2022f6d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerGuruHelp.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerGuruHelp.java
@@ -35,12 +35,12 @@
 public class AnalyzerGuruHelp {
     /**
      * Gets a reportable hunk of text that details
-     * {@link AnalyzerFramework#getPrefixesMap()},
-     * {@link AnalyzerFramework#getExtensionsMap()},
-     * {@link AnalyzerFramework#getMagicsMap()}, and
-     * {@link AnalyzerFramework#getAnalyzerFactoryMatchers()}.
+     * {@link AnalyzerGuru#getPrefixesMap()},
+     * {@link AnalyzerGuru#getExtensionsMap()},
+     * {@link AnalyzerGuru#getMagicsMap()}, and
+     * {@link AnalyzerGuru#getAnalyzerFactoryMatchers()}.
      * @return a defined, multi-line String
-     * @param analyzerGuru
+     * @param analyzerGuru an instance of analyzer guru with info about analyzers
      */
     public static String getUsage(AnalyzerGuru analyzerGuru) {
         StringBuilder b = new StringBuilder();

diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/authorization/AuthorizationEntity.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/authorization/AuthorizationEntity.java
@@ -476,7 +476,7 @@ public synchronized void setWorking() {
     /**
      * Check if this plugin has failed during loading or is missing.
      *
-     * This method has the same effect as !{@link isWorking()}.
+     * This method has the same effect as !{@link #isWorking()}.
      *
      * @return true if failed, true otherwise
      * @see #isWorking()

diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/framework/PluginFramework.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/framework/PluginFramework.java
@@ -347,6 +347,8 @@ private String getClassName(JarEntry f) {
      * <p>
      * When this is invoked, all plugins has been loaded into the memory and for each available plugin
      * the {@link #classLoaded(Object, Object)} was invoked.
+     *
+     * @param data a custom data created with {@link #beforeReload()}
      */
     protected abstract void afterReload(DataType data);