we are using the FindBugs build feature from the xml-report-plugin in our company. One thing that makes it uncomfortable to use is that the description of the FindBugs rule doesn't contain any formatting (it is stripped out).
- All the HTML tags are removed by xml-report-plugin (FindBugsReportParser.patternDetailsFound(), PatternXmlParser.getRootHandlers())
- Also the inspectionTabDetails.jsp in server-side-inspections plugin that displays the details escapes the XML characters
FindBugs details often contain HTML formatting for better readibility. We also modified the messages.xml with the details definition to provide more information with a link to our wiki page that gives guidance to our developers on how to treat FindBugs violations.
See the attachments to compare current and formatted outputs.
So my questions are:
- What was the reason to disallow HTML formatting in the inspection details description?
- Is there any possibility that it could be changed so that it preserves the formatting?
Thanks for any comments,