js: better javadoc for batch fixes, fix WEB-35903

GitOrigin-RevId: 176f6f77f2249ed9625d141791a17e3366a59937
This commit is contained in:
anstarovoyt
2019-10-01 14:03:21 +00:00
committed by intellij-monorepo-bot
parent 327e287514
commit 754758ba7b
@@ -22,14 +22,20 @@ import org.jetbrains.annotations.Nullable;
import java.util.List;
/**
* This interface must be used if you have some "custom" logic for batch fixes otherwise it is enough to implement equal {@link QuickFix#getFamilyName()} for the fixes.
*
* If the fixes don't have same "family name" the "Inspect all" view doesn't show "fix all" option
* so same family name must be used even if you implement the {@link BatchQuickFix} interface.
*/
public interface BatchQuickFix<D extends CommonProblemDescriptor> {
/**
* Called to apply the cumulative fix. Is invoked in WriteAction
*
* @param project {@link com.intellij.openapi.project.Project}
* @param descriptors problem reported by the tool on which fix should work
* @param project {@link Project}
* @param descriptors problem reported by the tool on which fix should work
* @param psiElementsToIgnore elements to be excluded from view during post-refresh
* @param refreshViews post-refresh inspection results view; would remove collected elements from the view
* @param refreshViews post-refresh inspection results view; would remove collected elements from the view
*/
void applyFix(@NotNull final Project project,
@NotNull final D[] descriptors,