javadoc

java/java-analysis-api/src/com/intellij/codeInspection/BaseJavaBatchLocalInspectionTool.java

@@ -20,6 +20,12 @@ import com.intellij.psi.PsiElement;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * Base java local inspection which provides batch suppress actions, i.e. actions which don't need UI components to run (e.g. Editor).
+ * Please use this class if your inspection and its fixes
+ *  - work with PSI or document only and
+ *  - don't provide {@link com.intellij.codeInsight.intention.IntentionAction} for quick fixes/suppression, making do with {@link LocalQuickFix} only.
+ */
 public abstract class BaseJavaBatchLocalInspectionTool extends AbstractBaseJavaLocalInspectionTool implements BatchSuppressableTool {
   @NotNull
   @Override

java/openapi/src/com/intellij/codeInspection/BaseJavaLocalInspectionTool.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2000-2012 JetBrains s.r.o.
+ * Copyright 2000-2013 JetBrains s.r.o.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,6 +27,9 @@ import org.jetbrains.annotations.NotNull;
  * lie under corresponding first parameter of one method.
  *
  * @see GlobalInspectionTool
+ *
+ * Please note that if your inspection/fixes/suppressions don't need UI components (e.g. Editor) to run, consider using
+ * {@link BaseJavaBatchLocalInspectionTool} instead.
  */
 public abstract class BaseJavaLocalInspectionTool extends AbstractBaseJavaLocalInspectionTool implements CustomSuppressableInspectionTool {
   @Override