]> source.dussan.org Git - sonarqube.git/commitdiff
Improve javadoc of org.sonar.api.utils.log.Logger
authorSimon Brandhof <simon.brandhof@sonarsource.com>
Wed, 25 Feb 2015 08:19:23 +0000 (09:19 +0100)
committerSimon Brandhof <simon.brandhof@sonarsource.com>
Wed, 25 Feb 2015 08:19:48 +0000 (09:19 +0100)
sonar-plugin-api/src/main/java/org/sonar/api/utils/log/Logger.java

index 27a226689108b3efb0d738dc39e0845a3080a46e..93d25ffd89f2b58fc82d4b36620d9c98855ae6e1 100644 (file)
@@ -27,11 +27,11 @@ import javax.annotation.Nullable;
  * Example:
  * <pre>
  * public class MyClass {
- *   private final Logger logger = Loggers.get("logger_name");
+ *   private static final Logger LOGGER = Loggers.get("logger_name");
  *
  *   public void doSomething() {
- *     logger.info("something valuable for production environment");
- *     logger.warn("message with arguments {} and {}", "foo", 42);
+ *     LOGGER.info("something valuable for production environment");
+ *     LOGGER.warn("message with arguments {} and {}", "foo", 42);
  *   }
  * }
  * </pre>
@@ -165,8 +165,8 @@ public interface Logger {
    * the underlying logging facility does not allow to change level at
    * runtime.
    * <p/>
-   * This method must not be used to enable debug logs in tests. Use
-   * {@link org.sonar.api.utils.log.LogTester#enableDebug(boolean)}.
+   * This method must not be used to enable DEBUG or TRACE logs in tests. Use
+   * {@link org.sonar.api.utils.log.LogTester#setLevel(LoggerLevel)} instead.
    * <p/>
    * The standard use-case is to customize logging of embedded 3rd-party
    * libraries.