From 934ecb2f45458660263d1ee47aeb7d0cd4596026 Mon Sep 17 00:00:00 2001 From: Bas Leijdekkers Date: Mon, 1 Jun 2020 14:23:06 +0200 Subject: [PATCH] add javadoc explanation GitOrigin-RevId: a5c28a8883385ce0dfb0e542cb3078de486d8d03 --- .../codeInspection/ex/InspectionElementsMerger.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/platform/analysis-api/src/com/intellij/codeInspection/ex/InspectionElementsMerger.java b/platform/analysis-api/src/com/intellij/codeInspection/ex/InspectionElementsMerger.java index 8f53b263c1da..51010183d515 100644 --- a/platform/analysis-api/src/com/intellij/codeInspection/ex/InspectionElementsMerger.java +++ b/platform/analysis-api/src/com/intellij/codeInspection/ex/InspectionElementsMerger.java @@ -14,7 +14,12 @@ import java.util.concurrent.ConcurrentMap; /** - * Merges multiple inspections settings {@link #getSourceToolNames()} into another one {@link #getMergedToolName()} + * Merges multiple inspections settings {@link #getSourceToolNames()} into another one {@link #getMergedToolName()}. + * + * Used to preserve backward compatibility when merging several inspections into one, or replacing an inspection with a different + * inspection. An inspection merger keeps existing @SuppressWarnings annotations working. It can also avoid the need to modify user + * inspection profiles, because a new inspection can take one or more old inspection’s settings, without the user needing to configure + * it again. * * {@see com.intellij.codeInspection.ex.InspectionElementsMergerBase} to provide more fine control over xml */