add javadoc explanation

GitOrigin-RevId: a5c28a8883385ce0dfb0e542cb3078de486d8d03
This commit is contained in:
Bas Leijdekkers
2020-06-01 17:31:34 +03:00
committed by intellij-monorepo-bot
parent f1a7fa7836
commit 934ecb2f45
@@ -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
*/