inspection documentation: exclude UI refs from documentation

GitOrigin-RevId: 168128b60ca13768334220b4c88dc904827a2d12
This commit is contained in:
Anna Kozlova
2021-03-22 13:20:51 +00:00
committed by intellij-monorepo-bot
parent 18005af143
commit 9546767d51
@@ -3,6 +3,7 @@
package com.intellij.codeInspection.actions;
import com.intellij.codeInspection.ex.InspectionToolWrapper;
import com.intellij.codeInspection.ui.InspectionNodeInfo;
import com.intellij.lang.documentation.AbstractDocumentationProvider;
import com.intellij.lang.documentation.DocumentationMarkup;
import com.intellij.openapi.util.text.StringUtil;
@@ -17,8 +18,13 @@ public class InspectionDescriptionDocumentationProvider extends AbstractDocument
}
InspectionToolWrapper toolWrapper = ((InspectionElement)element).getToolWrapper();
String description = toolWrapper.loadDescription();
if (description == null) {
return null;
}
return DocumentationMarkup.DEFINITION_START + StringUtil.escapeXmlEntities(toolWrapper.getDisplayName()) + DocumentationMarkup.DEFINITION_END +
DocumentationMarkup.CONTENT_START + toolWrapper.loadDescription() +
DocumentationMarkup.CONTENT_START +
InspectionNodeInfo.stripUIRefsFromInspectionDescription(description) +
DocumentationMarkup.CONTENT_END;
}
}