fixing javadoc errors

oracle · Feb 4, 2019 · c19d0f2 · c19d0f2
1 parent 5b83405
commit c19d0f2
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 12 deletions.
diff --git a/opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerFramework.java b/opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerFramework.java
@@ -188,7 +188,7 @@ protected void classLoaded(AnalyzersInfo localInfo, IAnalyzerPlugin plugin) {
             localInfo.fileTypeDescriptions.put(analyzer.getAnalyzer().getFileTypeName(), analyzer.getName());
         }
 
-        LOGGER.log(Level.INFO, "An analyzer factory {0} has been loaded.", analyzer.getClass().getCanonicalName());
+        LOGGER.log(Level.FINER, "An analyzer factory {0} has been loaded.", analyzer.getClass().getCanonicalName());
     }
 
     /**
@@ -216,7 +216,7 @@ protected AnalyzersInfo beforeReload() {
     @Override
     protected void afterReload(AnalyzersInfo localInfo) {
         if (getPluginDirectory() == null || !getPluginDirectory().isDirectory() || !getPluginDirectory().canRead()) {
-            LOGGER.log(Level.INFO, "No plugin directory for analyzers.");
+            LOGGER.log(Level.WARNING, "No plugin directory for analyzers.");
         }
 
         // apply custom settings for this framework
@@ -290,7 +290,7 @@ public void addPrefix(String prefix, AnalyzerFactory factory) {
             AnalyzerFactory oldFactory;
             if (factory == null) {
                 oldFactory = analyzersInfo.prefixes.remove(prefix);
-                LOGGER.log(Level.INFO,
+                LOGGER.log(Level.FINER,
                         "Removing a mapping for prefix {0}{1}",
                         new Object[]{
                                 prefix,
@@ -300,7 +300,7 @@ public void addPrefix(String prefix, AnalyzerFactory factory) {
 
             } else {
                 oldFactory = analyzersInfo.prefixes.put(prefix, factory);
-                LOGGER.log(Level.INFO,
+                LOGGER.log(Level.FINER,
                         "Adding a factory {0} for matching prefix {1}{2}",
                         new Object[]{
                                 factory.getClass().getCanonicalName(),
@@ -334,7 +334,7 @@ public void addExtension(String extension, AnalyzerFactory factory) {
             AnalyzerFactory oldFactory;
             if (factory == null) {
                 oldFactory = analyzersInfo.extensions.remove(extension);
-                LOGGER.log(Level.INFO,
+                LOGGER.log(Level.FINER,
                         "Removing a mapping for suffix {0}{1}",
                         new Object[]{
                                 extension,
@@ -343,7 +343,7 @@ public void addExtension(String extension, AnalyzerFactory factory) {
                 );
             } else {
                 oldFactory = analyzersInfo.extensions.put(extension, factory);
-                LOGGER.log(Level.INFO,
+                LOGGER.log(Level.FINER,
                         "Adding a factory {0} for matching suffix {1}{2}",
                         new Object[]{
                                 factory.getClass().getCanonicalName(),

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);